Class GoogleGenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.google.genai.GoogleGenAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

@Experimental
public class GoogleGenAiEmbeddingModel
extends DimensionAwareEmbeddingModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GoogleGenAiEmbeddingModel.Builder
static enum	GoogleGenAiEmbeddingModel.TaskTypeEnum

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
GoogleGenAiEmbeddingModel(GoogleGenAiEmbeddingModel.Builder builder)

Method Summary

Modifier and Type	Method	Description
static GoogleGenAiEmbeddingModel.Builder	builder()
EmbeddingResponse	doEmbed(EmbeddingRequest request)	Performs the embedding for EmbeddingModel.embed(EmbeddingRequest).
Response<Embedding>	embed(TextSegment textSegment)	Embed the text content of a TextSegment.
Response<Embedding>	embed(String text)	Embed a text.
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
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.
ModelProvider	provider()	The ModelProvider of this embedding model (for example ModelProvider.OPEN_AI).
Set<ContentType>	supportedContentTypes()	The input content types this model can embed.
Set<EmbeddingParameter<?>>	supportedParameters()	The per-call parameters this model honors.

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

Constructor Details

GoogleGenAiEmbeddingModel

public GoogleGenAiEmbeddingModel(GoogleGenAiEmbeddingModel.Builder builder)

Method Details

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.

supportedParameters

public Set<EmbeddingParameter<?>> supportedParameters()

Description copied from interface: EmbeddingModel

The per-call parameters this model honors. A request that populates a parameter outside this set is rejected by EmbeddingModel.embed(EmbeddingRequest) with an UnsupportedFeatureException, so a parameter a model cannot apply is never silently ignored. Defaults to an empty set (the model accepts no per-call parameters).

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.

embed

public Response<Embedding> embed(TextSegment textSegment)

Description copied from interface: EmbeddingModel

Embed the text content of a TextSegment.

This is a convenience method over EmbeddingModel.embed(EmbeddingRequest), so listeners are notified and the model's default per-call parameters are applied here too.

Parameters:

textSegment - the text segment to embed.

Returns:

the embedding.

embed

public Response<Embedding> embed(String text)

Description copied from interface: EmbeddingModel

Embed a text.

Parameters:

text - the text to embed.

Returns:

the embedding.

embedAll

public Response<List<Embedding>> embedAll(List<TextSegment> textSegments)

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

This is a convenience method over EmbeddingModel.embed(EmbeddingRequest), so listeners are notified and the model's default per-call parameters are applied here too. A provider implements its embedding logic by overriding EmbeddingModel.doEmbed(EmbeddingRequest) (preferred); it may still override this method for batch-specific behavior that the request/response API does not carry (for example applying a document title from TextSegment metadata).

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

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

knownDimension

public 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.

builder

public static GoogleGenAiEmbeddingModel.Builder builder()