Package org.springframework.ai.bedrock.titan.api

Class TitanEmbeddingBedrockApi

java.lang.Object

org.springframework.ai.bedrock.api.AbstractBedrockApi<TitanEmbeddingBedrockApi.TitanEmbeddingRequest,TitanEmbeddingBedrockApi.TitanEmbeddingResponse,TitanEmbeddingBedrockApi.TitanEmbeddingResponse>

org.springframework.ai.bedrock.titan.api.TitanEmbeddingBedrockApi

public class TitanEmbeddingBedrockApi
extends AbstractBedrockApi<TitanEmbeddingBedrockApi.TitanEmbeddingRequest,TitanEmbeddingBedrockApi.TitanEmbeddingResponse,TitanEmbeddingBedrockApi.TitanEmbeddingResponse>

Java client for the Bedrock Titan Embedding model. https://docs.aws.amazon.com/bedrock/latest/userguide/titan-multiemb-models.html

Since:

0.8.0

Author:

Christian Tzolov, Wei Jiang

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TitanEmbeddingBedrockApi.TitanEmbeddingModel	Titan Embedding model ids.
static final record	TitanEmbeddingBedrockApi.TitanEmbeddingRequest	Titan Embedding request parameters.
static final record	TitanEmbeddingBedrockApi.TitanEmbeddingResponse	Titan Embedding response.

Nested classes/interfaces inherited from class org.springframework.ai.bedrock.api.AbstractBedrockApi

AbstractBedrockApi.AmazonBedrockInvocationMetrics

Field Summary

Fields inherited from class org.springframework.ai.bedrock.api.AbstractBedrockApi

DEFAULT_EMIT_FAILURE_HANDLER

Constructor Summary

Constructors

Constructor	Description
TitanEmbeddingBedrockApi(String modelId, String region, Duration timeout)	Create a new TitanEmbeddingBedrockApi instance using the default credentials provider and default object mapper.
TitanEmbeddingBedrockApi(String modelId, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, String region, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Duration timeout)	Create a new TitanEmbeddingBedrockApi instance.
TitanEmbeddingBedrockApi(String modelId, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, software.amazon.awssdk.regions.Region region, com.fasterxml.jackson.databind.ObjectMapper objectMapper, Duration timeout)	Create a new TitanEmbeddingBedrockApi instance.

Method Summary

Modifier and Type	Method	Description
TitanEmbeddingBedrockApi.TitanEmbeddingResponse	embedding(TitanEmbeddingBedrockApi.TitanEmbeddingRequest request)	Compute the embedding for the given text.

Methods inherited from class org.springframework.ai.bedrock.api.AbstractBedrockApi

chatCompletion, chatCompletionStream, getModelId, getRegion, internalInvocation, internalInvocationStream

Methods inherited from class java.lang.Object

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

Constructor Details

TitanEmbeddingBedrockApi

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

Create a new TitanEmbeddingBedrockApi instance using the default credentials provider and default object mapper.

Parameters:

modelId - The model id to use. See the TitanEmbeddingBedrockApi.TitanEmbeddingModel for the supported models.

region - The AWS region to use.

timeout - The timeout to use.

TitanEmbeddingBedrockApi

public TitanEmbeddingBedrockApi(String modelId,
 software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
 String region,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 Duration timeout)

Create a new TitanEmbeddingBedrockApi instance.

Parameters:

modelId - The model id to use. See the TitanEmbeddingBedrockApi.TitanEmbeddingModel for the supported models.

credentialsProvider - The credentials provider to connect to AWS.

region - The AWS region to use.

objectMapper - The object mapper to use for JSON serialization and deserialization.

timeout - The timeout to use.

TitanEmbeddingBedrockApi

public TitanEmbeddingBedrockApi(String modelId,
 software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
 software.amazon.awssdk.regions.Region region,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 Duration timeout)

Create a new TitanEmbeddingBedrockApi instance.

Parameters:

modelId - The model id to use. See the TitanEmbeddingBedrockApi.TitanEmbeddingModel for the supported models.

credentialsProvider - The credentials provider to connect to AWS.

region - The AWS region to use.

objectMapper - The object mapper to use for JSON serialization and deserialization.

timeout - The timeout to use.

Method Details

embedding

public TitanEmbeddingBedrockApi.TitanEmbeddingResponse embedding(TitanEmbeddingBedrockApi.TitanEmbeddingRequest request)

Description copied from class: AbstractBedrockApi

Compute the embedding for the given text.

Overrides:

embedding in class AbstractBedrockApi<TitanEmbeddingBedrockApi.TitanEmbeddingRequest,TitanEmbeddingBedrockApi.TitanEmbeddingResponse,TitanEmbeddingBedrockApi.TitanEmbeddingResponse>

Parameters:

request - The embedding request.

Returns:

Returns the embedding response.