com.knuddels.jtokkit.api

Enum ModelType

java.lang.Object

java.lang.Enum<ModelType>

com.knuddels.jtokkit.api.ModelType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModelType>

public enum ModelType
extends java.lang.Enum<ModelType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADA
BABBAGE
CODE_CUSHMAN_001
CODE_CUSHMAN_002
CODE_DAVINCI_001
CODE_DAVINCI_002
CODE_DAVINCI_EDIT_001
CODE_SEARCH_ADA_CODE_001
CODE_SEARCH_BABBAGE_CODE_001
CURIE
CUSHMAN_CODEX
DAVINCI
DAVINCI_CODEX
GPT_3_5_TURBO
GPT_4
GPT_4_32K
TEXT_ADA_001
TEXT_BABBAGE_001
TEXT_CURIE_001
TEXT_DAVINCI_001
TEXT_DAVINCI_002
TEXT_DAVINCI_003
TEXT_DAVINCI_EDIT_001
TEXT_EMBEDDING_ADA_002
TEXT_SEARCH_ADA_DOC_001
TEXT_SEARCH_BABBAGE_DOC_001
TEXT_SEARCH_CURIE_DOC_001
TEXT_SEARCH_DAVINCI_DOC_001
TEXT_SIMILARITY_ADA_001
TEXT_SIMILARITY_BABBAGE_001
TEXT_SIMILARITY_CURIE_001
TEXT_SIMILARITY_DAVINCI_001

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<ModelType>	fromName(java.lang.String name) Returns a ModelType for the given name, or Optional.empty() if no such model type exists.
EncodingType	getEncodingType() Returns the encoding type that is used by this model type.
int	getMaxContextLength() Returns the maximum context length that is supported by this model type.
java.lang.String	getName() Returns the name of the model type as used by the OpenAI API.
static ModelType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ModelType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GPT_4

public static final ModelType GPT_4

GPT_4_32K

public static final ModelType GPT_4_32K

GPT_3_5_TURBO

public static final ModelType GPT_3_5_TURBO

TEXT_DAVINCI_003

public static final ModelType TEXT_DAVINCI_003

TEXT_DAVINCI_002

public static final ModelType TEXT_DAVINCI_002

TEXT_DAVINCI_001

public static final ModelType TEXT_DAVINCI_001

TEXT_CURIE_001

public static final ModelType TEXT_CURIE_001

TEXT_BABBAGE_001

public static final ModelType TEXT_BABBAGE_001

TEXT_ADA_001

public static final ModelType TEXT_ADA_001

DAVINCI

public static final ModelType DAVINCI

CURIE

public static final ModelType CURIE

BABBAGE

public static final ModelType BABBAGE

ADA

public static final ModelType ADA

CODE_DAVINCI_002

public static final ModelType CODE_DAVINCI_002

CODE_DAVINCI_001

public static final ModelType CODE_DAVINCI_001

CODE_CUSHMAN_002

public static final ModelType CODE_CUSHMAN_002

CODE_CUSHMAN_001

public static final ModelType CODE_CUSHMAN_001

DAVINCI_CODEX

public static final ModelType DAVINCI_CODEX

CUSHMAN_CODEX

public static final ModelType CUSHMAN_CODEX

TEXT_DAVINCI_EDIT_001

public static final ModelType TEXT_DAVINCI_EDIT_001

CODE_DAVINCI_EDIT_001

public static final ModelType CODE_DAVINCI_EDIT_001

TEXT_EMBEDDING_ADA_002

public static final ModelType TEXT_EMBEDDING_ADA_002

TEXT_SIMILARITY_DAVINCI_001

public static final ModelType TEXT_SIMILARITY_DAVINCI_001

TEXT_SIMILARITY_CURIE_001

public static final ModelType TEXT_SIMILARITY_CURIE_001

TEXT_SIMILARITY_BABBAGE_001

public static final ModelType TEXT_SIMILARITY_BABBAGE_001

TEXT_SIMILARITY_ADA_001

public static final ModelType TEXT_SIMILARITY_ADA_001

TEXT_SEARCH_DAVINCI_DOC_001

public static final ModelType TEXT_SEARCH_DAVINCI_DOC_001

TEXT_SEARCH_CURIE_DOC_001

public static final ModelType TEXT_SEARCH_CURIE_DOC_001

TEXT_SEARCH_BABBAGE_DOC_001

public static final ModelType TEXT_SEARCH_BABBAGE_DOC_001

TEXT_SEARCH_ADA_DOC_001

public static final ModelType TEXT_SEARCH_ADA_DOC_001

CODE_SEARCH_BABBAGE_CODE_001

public static final ModelType CODE_SEARCH_BABBAGE_CODE_001

CODE_SEARCH_ADA_CODE_001

public static final ModelType CODE_SEARCH_ADA_CODE_001

Method Detail

values

public static ModelType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModelType c : ModelType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModelType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Returns the name of the model type as used by the OpenAI API.

Returns:

the name of the model type

getEncodingType

public EncodingType getEncodingType()

Returns the encoding type that is used by this model type.

Returns:

the encoding type

getMaxContextLength

public int getMaxContextLength()

Returns the maximum context length that is supported by this model type. Note that the maximum context length consists of the amount of prompt tokens and the amount of completion tokens (where applicable).

Returns:

the maximum context length for this model type

fromName

public static java.util.Optional<ModelType> fromName(java.lang.String name)

Returns a ModelType for the given name, or Optional.empty() if no such model type exists.

Parameters:

name - the name of the model type

Returns:

the model type or Optional.empty()