Package org.springframework.ai.bedrock.titan

Class BedrockTitanEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.bedrock.titan.BedrockTitanEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>

public class BedrockTitanEmbeddingModel
extends AbstractEmbeddingModel

EmbeddingModel implementation that uses the Bedrock Titan Embedding API. Titan Embedding supports text and image (encoded in base64) inputs. Note: Titan Embedding does not support batch embedding.

Since:

0.8.0

Author:

Christian Tzolov, Wei Jiang

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BedrockTitanEmbeddingModel.InputType

Field Summary

Fields inherited from class org.springframework.ai.embedding.AbstractEmbeddingModel

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
BedrockTitanEmbeddingModel(TitanEmbeddingBedrockApi titanEmbeddingBedrockApi)

Method Summary

Modifier and Type	Method	Description
EmbeddingResponse	call(EmbeddingRequest request)	Executes a method call to the AI model.
int	dimensions()	Get the number of dimensions of the embedded vectors.
float[]	embed(Document document)	Embeds the given document's content into a vector.
BedrockTitanEmbeddingModel	withInputType(BedrockTitanEmbeddingModel.InputType inputType)	Titan Embedding API input types.

Methods inherited from class org.springframework.ai.embedding.AbstractEmbeddingModel

dimensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.embedding.EmbeddingModel

embed, embed, embed, embedForResponse

Constructor Details

BedrockTitanEmbeddingModel

public BedrockTitanEmbeddingModel(TitanEmbeddingBedrockApi titanEmbeddingBedrockApi)

Method Details

withInputType

public BedrockTitanEmbeddingModel withInputType(BedrockTitanEmbeddingModel.InputType inputType)

Titan Embedding API input types. Could be either text or image (encoded in base64).

Parameters:

inputType - the input type to use.

embed

public float[] embed(Document document)

Description copied from interface: EmbeddingModel

Embeds the given document's content into a vector.

Parameters:

document - the document to embed.

Returns:

the embedded vector.

call

public EmbeddingResponse call(EmbeddingRequest request)

Description copied from interface: Model

Executes a method call to the AI model.

Parameters:

request - the request object to be sent to the AI model

Returns:

the response from the AI model

dimensions

public int dimensions()

Description copied from interface: EmbeddingModel

Get the number of dimensions of the embedded vectors. Note that by default, this method will call the remote Embedding endpoint to get the dimensions of the embedded vectors. If the dimensions are known ahead of time, it is recommended to override this method.

Specified by:

dimensions in interface EmbeddingModel

Overrides:

dimensions in class AbstractEmbeddingModel

Returns:

the number of dimensions of the embedded vectors.