Package org.springframework.ai.openai.api

Enum Class OpenAiApi.EmbeddingModel

java.lang.Object

java.lang.Enum<OpenAiApi.EmbeddingModel>

org.springframework.ai.openai.api.OpenAiApi.EmbeddingModel

All Implemented Interfaces:

Serializable, Comparable<OpenAiApi.EmbeddingModel>, Constable

Enclosing class:

OpenAiApi

public static enum OpenAiApi.EmbeddingModel
extends Enum<OpenAiApi.EmbeddingModel>

OpenAI Embeddings Models: Embeddings.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
TEXT_EMBEDDING_3_LARGE	Most capable embedding model for both english and non-english tasks.
TEXT_EMBEDDING_3_SMALL	Increased performance over 2nd generation ada embedding model.
TEXT_EMBEDDING_ADA_002	Most capable 2nd generation embedding model, replacing 16 first generation models.

Field Summary

Fields

Modifier and Type	Field	Description
final String	value

Method Summary

Modifier and Type	Method	Description
String	getValue()
static OpenAiApi.EmbeddingModel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAiApi.EmbeddingModel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT_EMBEDDING_3_LARGE

public static final OpenAiApi.EmbeddingModel TEXT_EMBEDDING_3_LARGE

Most capable embedding model for both english and non-english tasks. DIMENSION: 3072

TEXT_EMBEDDING_3_SMALL

public static final OpenAiApi.EmbeddingModel TEXT_EMBEDDING_3_SMALL

Increased performance over 2nd generation ada embedding model. DIMENSION: 1536

TEXT_EMBEDDING_ADA_002

public static final OpenAiApi.EmbeddingModel TEXT_EMBEDDING_ADA_002

Most capable 2nd generation embedding model, replacing 16 first generation models. DIMENSION: 1536

Field Details

value

public final String value

Method Details

values

public static OpenAiApi.EmbeddingModel[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OpenAiApi.EmbeddingModel valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()