Package org.springframework.ai.bedrock.cohere.api

Enum Class CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

java.lang.Object

java.lang.Enum<CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType>

org.springframework.ai.bedrock.cohere.api.CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType

All Implemented Interfaces:

Serializable, Comparable<CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType>, Constable

Enclosing class:

CohereEmbeddingBedrockApi.CohereEmbeddingRequest

public static enum CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType
extends Enum<CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType>

Cohere Embedding API input types.

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	Use classification when using embeddings as an input to a text classifier.
CLUSTERING	Use clustering to cluster the embeddings.
SEARCH_DOCUMENT	In search use-cases, use search_document when you encode documents for embeddings that you store in a vector database.
SEARCH_QUERY	Use search_query when querying your vector DB to find relevant documents.

Method Summary

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

SEARCH_DOCUMENT

public static final CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType SEARCH_DOCUMENT

In search use-cases, use search_document when you encode documents for embeddings that you store in a vector database.

SEARCH_QUERY

public static final CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType SEARCH_QUERY

Use search_query when querying your vector DB to find relevant documents.

CLASSIFICATION

public static final CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType CLASSIFICATION

Use classification when using embeddings as an input to a text classifier.

CLUSTERING

public static final CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType CLUSTERING

Use clustering to cluster the embeddings.

Method Details

values

public static CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType[] 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 CohereEmbeddingBedrockApi.CohereEmbeddingRequest.InputType 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