获取最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

谷歌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 仓库中。 请参阅 工件仓库 部分，以将这些仓库添加到您的构建系统。spring-doc.cadn.net.cn

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

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

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

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

或者添加到您的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嵌入式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

顶点AIspring-doc.cadn.net.cn

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

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

text-embedding-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

示例控制器

创建一个新的Spring Boot项目，并将spring-boot-starter-web添加到您的pom（或gradle）依赖中。spring-doc.cadn.net.cn

在src/main/resources目录下添加一个application.properties文件，以启用并配置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>

或者添加到您的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());