Package org.springframework.ai.google.genai.text

Class GoogleGenAiTextEmbeddingModel

java.lang.Object

org.springframework.ai.embedding.AbstractEmbeddingModel

org.springframework.ai.google.genai.text.GoogleGenAiTextEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, Model<EmbeddingRequest,EmbeddingResponse>

public class GoogleGenAiTextEmbeddingModel
extends AbstractEmbeddingModel

A class representing a Vertex AI Text Embedding Model using the new Google Gen AI SDK.

Since:

1.0.0

Author:

Christian Tzolov, Mark Pollack, Rodrigo Malara, Soby Chacko, Dan Dobrin

Field Summary

Fields

Modifier and Type	Field	Description
final GoogleGenAiTextEmbeddingOptions	defaultOptions

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

embeddingDimensions

Constructor Summary

Constructors

Constructor	Description
GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails, GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions)
GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails, GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions, org.springframework.retry.support.RetryTemplate retryTemplate)
GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails, GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)

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.
void	setObservationConvention(EmbeddingModelObservationConvention observationConvention)	Use the provided convention for reporting observation data

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

Field Details

defaultOptions

public final GoogleGenAiTextEmbeddingOptions defaultOptions

Constructor Details

GoogleGenAiTextEmbeddingModel

public GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails,
 GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions)

GoogleGenAiTextEmbeddingModel

public GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails,
 GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate)

GoogleGenAiTextEmbeddingModel

public GoogleGenAiTextEmbeddingModel(GoogleGenAiEmbeddingConnectionDetails connectionDetails,
 GoogleGenAiTextEmbeddingOptions defaultEmbeddingOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

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.

setObservationConvention

public void setObservationConvention(EmbeddingModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention