Google VertexAI 文本嵌入

Vertex AI 支持两种类型的嵌入模型：文本和多模态。 本文档介绍如何使用 Vertex AI 文本嵌入 API 创建文本嵌入。spring-doc.cadn.net.cn

Vertex AI 文本嵌入 API 使用密集矢量表示形式。 与倾向于将单词直接映射到数字的稀疏向量不同，密集向量旨在更好地表示一段文本的含义。 在生成式 AI 中使用密集向量嵌入的好处是，即使这些段落不使用相同的语言，您也可以更好地搜索与查询含义一致的段落，而不是搜索直接的单词或语法匹配。spring-doc.cadn.net.cn

前提条件

gcloud config set project <PROJECT_ID> &&
gcloud auth application-default login <ACCOUNT>

添加存储库和 BOM

Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Artifact Repositories 部分，将这些存储库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助进行依赖管理，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

自动配置

Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息，请参阅升级说明。spring-doc.cadn.net.cn

Spring AI 为 VertexAI 嵌入模型提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-vertex-ai-embedding</artifactId>
</dependency>

或 Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-vertex-ai-embedding'
}
请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。

嵌入属性

前缀spring.ai.vertex.ai.embedding用作属性前缀，用于连接到 VertexAI Embedding API。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.vertex.ai.embedding.project-idspring-doc.cadn.net.cn

Google Cloud Platform 项目 IDspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.locationspring-doc.cadn.net.cn

地区spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.apiEndpointspring-doc.cadn.net.cn

Vertex AI 嵌入 API 端点。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

现在，通过前缀spring.ai.model.embedding.spring-doc.cadn.net.cn

要启用，spring.ai.model.embedding.text=vertexai（默认启用）spring-doc.cadn.net.cn

要禁用，spring.ai.model.embedding.text=none（或任何与 vertexai 不匹配的值）spring-doc.cadn.net.cn

进行此更改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀spring.ai.vertex.ai.embedding.text是属性前缀，用于配置 VertexAI 文本嵌入的嵌入模型实现。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.vertex.ai.embedding.text.enabled（已删除且不再有效）spring-doc.cadn.net.cn

启用 Vertex AI 嵌入 API 模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.embedding.textspring-doc.cadn.net.cn

启用 Vertex AI 嵌入 API 模型。spring-doc.cadn.net.cn

顶点赛spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.text.options.modelspring-doc.cadn.net.cn

这是要使用的顶点文本嵌入模型spring-doc.cadn.net.cn

文本嵌入-004spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.text.options.task-typespring-doc.cadn.net.cn

预期的下游应用程序，以帮助模型生成更高质量的嵌入。可用的任务类型spring-doc.cadn.net.cn

RETRIEVAL_DOCUMENTspring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.text.options.titlespring-doc.cadn.net.cn

可选标题，仅在 task_type=RETRIEVAL_DOCUMENT 时有效。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.text.options.dimensionsspring-doc.cadn.net.cn

生成的输出嵌入应具有的维度数。支持模型版本 004 及更高版本。您可以使用此参数来减小嵌入大小，例如，用于存储优化。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.text.options.auto-truncatespring-doc.cadn.net.cn

当设置为 true 时，输入文本将被截断。当设置为 false 时，如果输入文本长于模型支持的最大长度，则返回错误。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

Samples控制器

创建一个新的 Spring Boot 项目，并将spring-ai-starter-model-vertex-ai-embedding到你的 pom（或 gradle）依赖项。spring-doc.cadn.net.cn

添加一个application.properties文件，在src/main/resources目录中，以启用和配置 VertexAi 聊天模型：spring-doc.cadn.net.cn

spring.ai.vertex.ai.embedding.project-id=<YOUR_PROJECT_ID>
spring.ai.vertex.ai.embedding.location=<YOUR_PROJECT_LOCATION>
spring.ai.vertex.ai.embedding.text.options.model=text-embedding-004

这将创建一个VertexAiTextEmbeddingModel您可以注入到类中的实现。这是一个简单的示例@Controller使用嵌入模型进行嵌入代的类。spring-doc.cadn.net.cn

@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingModel.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

VertexAiTextEmbeddingModel 实现了EmbeddingModel.spring-doc.cadn.net.cn

添加spring-ai-vertex-ai-embedding对项目 Maven 的依赖pom.xml文件：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-vertex-ai-embedding</artifactId>
</dependency>

或 Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-vertex-ai-embedding'
}
请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。

接下来，创建一个VertexAiTextEmbeddingModel并将其用于文本生成：spring-doc.cadn.net.cn

VertexAiEmbeddingConnectionDetails connectionDetails =
    VertexAiEmbeddingConnectionDetails.builder()
        .projectId(System.getenv(<VERTEX_AI_GEMINI_PROJECT_ID>))
        .location(System.getenv(<VERTEX_AI_GEMINI_LOCATION>))
        .build();

VertexAiTextEmbeddingOptions options = VertexAiTextEmbeddingOptions.builder()
    .model(VertexAiTextEmbeddingOptions.DEFAULT_MODEL_NAME)
    .build();

var embeddingModel = new VertexAiTextEmbeddingModel(this.connectionDetails, this.options);

EmbeddingResponse embeddingResponse = this.embeddingModel
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

从 Google 服务帐号加载凭据

要以编程方式从服务帐号 json 文件加载 GoogleCredentials，您可以使用以下命令：spring-doc.cadn.net.cn

GoogleCredentials credentials = GoogleCredentials.fromStream(<INPUT_STREAM_TO_CREDENTIALS_JSON>)
        .createScoped("https://www.googleapis.com/auth/cloud-platform");
credentials.refreshIfExpired();

VertexAiEmbeddingConnectionDetails connectionDetails =
    VertexAiEmbeddingConnectionDetails.builder()
        .projectId(System.getenv(<VERTEX_AI_GEMINI_PROJECT_ID>))
        .location(System.getenv(<VERTEX_AI_GEMINI_LOCATION>))
        .apiEndpoint(endpoint)
        .predictionServiceSettings(
            PredictionServiceSettings.newBuilder()
                .setEndpoint(endpoint)
                .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
                .build());