Class CohereEmbeddingBedrockApi

java.lang.Object

org.springframework.ai.bedrock.api.AbstractBedrockApi<CohereEmbeddingBedrockApi.CohereEmbeddingRequest, CohereEmbeddingBedrockApi.CohereEmbeddingResponse, CohereEmbeddingBedrockApi.CohereEmbeddingResponse>

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

public class CohereEmbeddingBedrockApi
extends AbstractBedrockApi<CohereEmbeddingBedrockApi.CohereEmbeddingRequest, CohereEmbeddingBedrockApi.CohereEmbeddingResponse, CohereEmbeddingBedrockApi.CohereEmbeddingResponse>

Cohere Embedding API. AWS Bedrock Cohere Embedding API Based on the Cohere Embedding API

Since:

0.8.0

Author:

Christian Tzolov, Wei Jiang

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CohereEmbeddingBedrockApi.CohereEmbeddingModel	Cohere Embedding model ids. https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids-arns.html
static final record	CohereEmbeddingBedrockApi.CohereEmbeddingRequest	The Cohere Embed model request.
static final record	CohereEmbeddingBedrockApi.CohereEmbeddingResponse	Cohere Embedding response.

Nested classes/interfaces inherited from class AbstractBedrockApi

AbstractBedrockApi.AmazonBedrockInvocationMetrics

Field Summary

Fields inherited from class AbstractBedrockApi

DEFAULT_EMIT_FAILURE_HANDLER

Constructor Summary

Constructors

Constructor	Description
CohereEmbeddingBedrockApi(String modelId, String region)	Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.
CohereEmbeddingBedrockApi(String modelId, String region, Duration timeout)	Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.
CohereEmbeddingBedrockApi(String modelId, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, String region, tools.jackson.databind.json.JsonMapper jsonMapper)	Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.
CohereEmbeddingBedrockApi(String modelId, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, String region, tools.jackson.databind.json.JsonMapper jsonMapper, Duration timeout)	Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.
CohereEmbeddingBedrockApi(String modelId, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, software.amazon.awssdk.regions.Region region, tools.jackson.databind.json.JsonMapper jsonMapper, Duration timeout)	Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and JSON mapper.

Method Summary

Modifier and Type	Method	Description
CohereEmbeddingBedrockApi.CohereEmbeddingResponse	embedding(CohereEmbeddingBedrockApi.CohereEmbeddingRequest request)	Compute the embedding for the given text.

Methods inherited from class AbstractBedrockApi

chatCompletion, chatCompletionStream, getModelId, getRegion, internalInvocation, internalInvocationStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CohereEmbeddingBedrockApi

public CohereEmbeddingBedrockApi(String modelId,
 String region)

Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.

Parameters:

modelId - The model id to use. See the CohereEmbeddingBedrockApi.CohereEmbeddingModel for the supported models.

region - The AWS region to use.

CohereEmbeddingBedrockApi

public CohereEmbeddingBedrockApi(String modelId,
 software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
 String region,
 tools.jackson.databind.json.JsonMapper jsonMapper)

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.

Parameters:

modelId - The model id to use. See the CohereEmbeddingBedrockApi.CohereEmbeddingModel for the supported models.

credentialsProvider - The credentials provider to connect to AWS.

region - The AWS region to use.

jsonMapper - The JSON mapper to use for JSON serialization and deserialization.

CohereEmbeddingBedrockApi

public CohereEmbeddingBedrockApi(String modelId,
 String region,
 Duration timeout)

Create a new CohereEmbeddingBedrockApi instance using the default credentials provider chain, the default object mapper, default temperature and topP values.

Parameters:

modelId - The model id to use. See the CohereEmbeddingBedrockApi.CohereEmbeddingModel for the supported models.

region - The AWS region to use.

timeout - The timeout to use.

CohereEmbeddingBedrockApi

public CohereEmbeddingBedrockApi(String modelId,
 software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
 String region,
 tools.jackson.databind.json.JsonMapper jsonMapper,
 Duration timeout)

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and object mapper.

Parameters:

modelId - The model id to use. See the CohereEmbeddingBedrockApi.CohereEmbeddingModel for the supported models.

credentialsProvider - The credentials provider to connect to AWS.

region - The AWS region to use.

jsonMapper - The JSON mapper to use for JSON serialization and deserialization.

timeout - The timeout to use.

CohereEmbeddingBedrockApi

public CohereEmbeddingBedrockApi(String modelId,
 software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
 software.amazon.awssdk.regions.Region region,
 tools.jackson.databind.json.JsonMapper jsonMapper,
 Duration timeout)

Create a new CohereEmbeddingBedrockApi instance using the provided credentials provider, region and JSON mapper.

Parameters:

modelId - The model id to use. See the CohereEmbeddingBedrockApi.CohereEmbeddingModel for the supported models.

credentialsProvider - The credentials provider to connect to AWS.

region - The AWS region to use.

jsonMapper - The JSON mapper to use for JSON serialization and deserialization.

timeout - The timeout to use.

Method Details

embedding

public CohereEmbeddingBedrockApi.CohereEmbeddingResponse embedding(CohereEmbeddingBedrockApi.CohereEmbeddingRequest request)

Description copied from class: AbstractBedrockApi

Compute the embedding for the given text.

Overrides:

embedding in class AbstractBedrockApi<CohereEmbeddingBedrockApi.CohereEmbeddingRequest, CohereEmbeddingBedrockApi.CohereEmbeddingResponse, CohereEmbeddingBedrockApi.CohereEmbeddingResponse>

Parameters:

request - The embedding request.

Returns:

Returns the embedding response.