Class VertexAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.vertexai.VertexAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class VertexAiEmbeddingModel
extends DimensionAwareEmbeddingModel

Represents a Google Vertex AI embedding model, such as textembedding-gecko. See details here.

This embedding model transparently handles call batching, however the underlying API has imposes a maximum of 250 embeddings per call, with a max of 20,000 tokens per call. You can tweak those two parameters with the maxSegmentsPerBatch() and maxTokensPerBatch() builder methods. For example, if you hit the 20,000 error, set maxTokensPerBatch(18_000).

For authentication and authorization, please follow these steps before using this model:
1. Authentication
When developing locally, you can use one of:
a) Google Cloud SDK
b) Service account When using service account, ensure that GOOGLE_APPLICATION_CREDENTIALS environment variable points to your JSON service account key.
2. Authorization
3. Prerequisites

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiEmbeddingModel.Builder
static enum	VertexAiEmbeddingModel.TaskType

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
VertexAiEmbeddingModel(VertexAiEmbeddingModel.Builder builder)
VertexAiEmbeddingModel(String endpoint, String project, String location, String publisher, String modelName, Integer maxRetries, Integer maxSegmentsPerBatch, Integer maxTokensPerBatch, VertexAiEmbeddingModel.TaskType taskType, String titleMetadataKey, Integer outputDimensionality, Boolean autoTruncate)	Deprecated, for removal: This API element is subject to removal in a future version. Please use VertexAiEmbeddingModel(Builder) instead

Method Summary

Modifier and Type	Method	Description
static VertexAiEmbeddingModel.Builder	builder()
List<Integer>	calculateTokensCounts(List<TextSegment> segments)	Calculates the number of tokens for each segment in the input list.
Response<List<Embedding>>	embedAll(List<TextSegment> segments)	Embeds the text content of a list of TextSegments.
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.

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

embed, embed

Constructor Details

VertexAiEmbeddingModel

public VertexAiEmbeddingModel(VertexAiEmbeddingModel.Builder builder)

VertexAiEmbeddingModel

@Deprecated(forRemoval=true,
            since="1.2.0")
public VertexAiEmbeddingModel(String endpoint,
 String project,
 String location,
 String publisher,
 String modelName,
 Integer maxRetries,
 Integer maxSegmentsPerBatch,
 Integer maxTokensPerBatch,
 VertexAiEmbeddingModel.TaskType taskType,
 String titleMetadataKey,
 Integer outputDimensionality,
 Boolean autoTruncate)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use VertexAiEmbeddingModel(Builder) instead

Method Details

embedAll

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

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

Parameters:

segments - the text segments to embed.

Returns:

the embeddings.

calculateTokensCounts

public List<Integer> calculateTokensCounts(List<TextSegment> segments)

Calculates the number of tokens for each segment in the input list.

Parameters:

segments - a list of TextSegments

Returns:

a list of tokens counts for each segment

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.

builder

public static VertexAiEmbeddingModel.Builder builder()