Package org.springframework.ai.vertexai.embedding.text

Enum Class VertexAiTextEmbeddingOptions.TaskType

java.lang.Object

java.lang.Enum<VertexAiTextEmbeddingOptions.TaskType>

org.springframework.ai.vertexai.embedding.text.VertexAiTextEmbeddingOptions.TaskType

All Implemented Interfaces:

Serializable, Comparable<VertexAiTextEmbeddingOptions.TaskType>, Constable

Enclosing class:

VertexAiTextEmbeddingOptions

public static enum VertexAiTextEmbeddingOptions.TaskType
extends Enum<VertexAiTextEmbeddingOptions.TaskType>

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
CLASSIFICATION	Specifies that the embeddings will be used for classification.
CLUSTERING	Specifies that the embeddings will be used for clustering.
FACT_VERIFICATION	Specifies that the query embedding is used for fact verification.
QUESTION_ANSWERING	Specifies that the query embedding is used for answering questions.
RETRIEVAL_DOCUMENT	Specifies the given text is a query in a search/retrieval setting.
RETRIEVAL_QUERY	Specifies the given text is a document in a search/retrieval setting.
SEMANTIC_SIMILARITY	Specifies the given text will be used for semantic textual similarity (STS).

Method Summary

Modifier and Type	Method	Description
static VertexAiTextEmbeddingOptions.TaskType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VertexAiTextEmbeddingOptions.TaskType[]	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

RETRIEVAL_QUERY

public static final VertexAiTextEmbeddingOptions.TaskType RETRIEVAL_QUERY

Specifies the given text is a document in a search/retrieval setting.

RETRIEVAL_DOCUMENT

public static final VertexAiTextEmbeddingOptions.TaskType RETRIEVAL_DOCUMENT

Specifies the given text is a query in a search/retrieval setting.

SEMANTIC_SIMILARITY

public static final VertexAiTextEmbeddingOptions.TaskType SEMANTIC_SIMILARITY

Specifies the given text will be used for semantic textual similarity (STS).

CLASSIFICATION

public static final VertexAiTextEmbeddingOptions.TaskType CLASSIFICATION

Specifies that the embeddings will be used for classification.

CLUSTERING

public static final VertexAiTextEmbeddingOptions.TaskType CLUSTERING

Specifies that the embeddings will be used for clustering.

QUESTION_ANSWERING

public static final VertexAiTextEmbeddingOptions.TaskType QUESTION_ANSWERING

Specifies that the query embedding is used for answering questions. Use RETRIEVAL_DOCUMENT for the document side.

FACT_VERIFICATION

public static final VertexAiTextEmbeddingOptions.TaskType FACT_VERIFICATION

Specifies that the query embedding is used for fact verification.

Method Details

values

public static VertexAiTextEmbeddingOptions.TaskType[] 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 VertexAiTextEmbeddingOptions.TaskType 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