Class BedrockTitanEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.bedrock.BedrockTitanEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class BedrockTitanEmbeddingModel
extends DimensionAwareEmbeddingModel

Bedrock Amazon Titan embedding model with support for both versions: amazon.titan-embed-text-v1 and amazon.titan-embed-text-v2:0
See more details here and here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<C extends BedrockTitanEmbeddingModel, B extends BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<C,B>>
static enum	BedrockTitanEmbeddingModel.Types

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BedrockTitanEmbeddingModel(BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
static BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<?,?>	builder()
EmbeddingResponse	doEmbed(EmbeddingRequest request)	Performs the embedding for EmbeddingModel.embed(EmbeddingRequest).
protected Response<List<Embedding>>	doEmbedAll(List<TextSegment> textSegments)
software.amazon.awssdk.services.bedrockruntime.BedrockRuntimeClient	getClient()
software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialsProvider()
Integer	getDimensions()
Integer	getMaxRetries()
String	getModel()
protected String	getModelId()	Get model id
Boolean	getNormalize()
software.amazon.awssdk.regions.Region	getRegion()
protected List<Map<String,Object>>	getRequestParameters(List<TextSegment> textSegments)	Get request body
protected Class<dev.langchain4j.model.bedrock.BedrockTitanEmbeddingResponse>	getResponseClassType()	Get response class type
protected software.amazon.awssdk.services.bedrockruntime.model.InvokeModelResponse	invoke(String body)	Invoke model
protected Integer	knownDimension()	When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model.
List<EmbeddingModelListener>	listeners()	The EmbeddingModelListeners that are notified around EmbeddingModel.embed(EmbeddingRequest).
String	modelName()	Returns the name of the underlying embedding model.
protected static Map<String,Object>	of(String key, Object value)	Create map with single entry
ModelProvider	provider()	The ModelProvider of this embedding model (for example ModelProvider.OPEN_AI).
Set<ContentType>	supportedContentTypes()	The input content types this model can embed.

Methods inherited from class DimensionAwareEmbeddingModel

dimension

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

addListener, addListeners, defaultRequestParameters, embed, embed, embed, embedAll, supportedParameters

Constructor Details

BedrockTitanEmbeddingModel

protected BedrockTitanEmbeddingModel(BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<?,?> builder)

Method Details

getModelId

protected String getModelId()

Get model id

Returns:

model id

knownDimension

protected Integer knownDimension()

Description copied from class: DimensionAwareEmbeddingModel

When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model. Otherwise, it returns null.

Overrides:

knownDimension in class DimensionAwareEmbeddingModel

Returns:

the known dimension of the Embedding, or null if unknown.

getRequestParameters

protected List<Map<String,Object>> getRequestParameters(List<TextSegment> textSegments)

Get request body

Parameters:

textSegments - Input texts to convert to embedding

Returns:

request body

getResponseClassType

protected Class<dev.langchain4j.model.bedrock.BedrockTitanEmbeddingResponse> getResponseClassType()

Get response class type

Returns:

response class type

supportedContentTypes

public Set<ContentType> supportedContentTypes()

Description copied from interface: EmbeddingModel

The input content types this model can embed. A request whose inputs use a content type outside this set is rejected by EmbeddingModel.embed(EmbeddingRequest) with an UnsupportedFeatureException. Defaults to {TEXT}; a multimodal model overrides this to also accept, for example, images.

doEmbed

public EmbeddingResponse doEmbed(EmbeddingRequest request)

Description copied from interface: EmbeddingModel

Performs the embedding for EmbeddingModel.embed(EmbeddingRequest). This is the low-level method a provider overrides to build the actual API call; EmbeddingModel.embed(EmbeddingRequest) handles per-call parameter validation and listener dispatch around it.

An implementation must override either this method (preferred) or EmbeddingModel.embedAll(List) — the two have mutually-recursive defaults, so overriding neither leads to infinite recursion. The default implementation embeds the text of each input via EmbeddingModel.embedAll(List), which keeps implementations that only provide EmbeddingModel.embedAll(List) working.

When this method is called, the request's parameters have already been merged with EmbeddingModel.defaultRequestParameters() and validated against EmbeddingModel.supportedParameters() and EmbeddingModel.supportedContentTypes().

Parameters:

request - the request, with parameters already merged and validated.

Returns:

the response.

getModel

public String getModel()

getDimensions

public Integer getDimensions()

getNormalize

public Boolean getNormalize()

builder

public static BedrockTitanEmbeddingModel.BedrockTitanEmbeddingModelBuilder<?,?> builder()

doEmbedAll

protected Response<List<Embedding>> doEmbedAll(List<TextSegment> textSegments)

listeners

public List<EmbeddingModelListener> listeners()

Description copied from interface: EmbeddingModel

The EmbeddingModelListeners that are notified around EmbeddingModel.embed(EmbeddingRequest). Configure them on the model's builder (via listeners(...)). Defaults to an empty list.

provider

public ModelProvider provider()

Description copied from interface: EmbeddingModel

The ModelProvider of this embedding model (for example ModelProvider.OPEN_AI). It is made available to listeners through the request, response and error contexts. Defaults to ModelProvider.OTHER.

modelName

public String modelName()

Description copied from interface: EmbeddingModel

Returns the name of the underlying embedding model.

Implementations are encouraged to override this method and provide the actual model name. The default implementation returns "unknown", which indicates that the model name is unknown.

Returns:

the model name or a fallback value if not provided

getClient

public software.amazon.awssdk.services.bedrockruntime.BedrockRuntimeClient getClient()

invoke

protected software.amazon.awssdk.services.bedrockruntime.model.InvokeModelResponse invoke(String body)

Invoke model

Parameters:

body - body

Returns:

invoke model response

of

protected static Map<String,Object> of(String key,
 Object value)

Create map with single entry

Parameters:

key - key

value - value

Returns:

map

getRegion

public software.amazon.awssdk.regions.Region getRegion()

getCredentialsProvider

public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialsProvider()

getMaxRetries

public Integer getMaxRetries()