跳到主要内容

智谱AI Embeddings

DeepSeek V3 中英对照 ZhiPu AI ZhiPuAI Embeddings

Spring AI 支持智谱AI的文本嵌入模型。智谱AI的文本嵌入用于衡量文本字符串之间的相关性。嵌入是一个浮点数组成的向量（列表）。两个向量之间的距离衡量了它们的相关性。距离小表示相关性高，距离大表示相关性低。

先决条件​

你需要创建一个与 ZhiPuAI 的 API 来访问 ZhiPu AI 语言模型。

在 ZhiPu AI 注册页面 创建一个账户，并在 API Keys 页面 生成 token。Spring AI 项目定义了一个名为 spring.ai.zhipu.api-key 的配置属性，你应该将其设置为从 API Keys 页面 获取的 API Key 的值。导出环境变量是设置该配置属性的一种方式：

export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>
shell

添加仓库和 BOM​

Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分，将这些仓库添加到您的构建系统中。

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

自动配置​

Spring AI 提供了对 Azure ZhiPuAI Embedding 模型的 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-zhipuai-spring-boot-starter</artifactId>
</dependency>
xml

或到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}
groovy

:::提示
请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
:::

嵌入属性​

重试属性​

前缀 spring.ai.retry 用作属性前缀，允许您为 ZhiPuAI Embedding 模型配置重试机制。

属性描述默认值
spring.ai.retry.max-attempts最大重试次数。10
spring.ai.retry.backoff.initial-interval指数退避策略的初始休眠时间。2 秒
spring.ai.retry.backoff.multiplier退避间隔乘数。5
spring.ai.retry.backoff.max-interval最大退避时间。3 分钟
spring.ai.retry.on-client-errors如果为 false，则抛出 NonTransientAiException，并且不对 4xx 客户端错误代码进行重试false
spring.ai.retry.exclude-on-http-codes不应触发重试的 HTTP 状态代码列表（例如抛出 NonTransientAiException）。空
spring.ai.retry.on-http-codes应触发重试的 HTTP 状态代码列表（例如抛出 TransientAiException）。空

连接属性​

前缀 spring.ai.zhipuai 用作属性前缀，允许你连接到 ZhiPuAI。

属性描述默认值
spring.ai.zhipuai.base-url连接的 URLopen.bigmodel.cn/api/paas
spring.ai.zhipuai.api-keyAPI 密钥-

配置属性​

前缀 spring.ai.zhipuai.embedding 是一个用于配置 ZhiPuAI 的 EmbeddingModel 实现的属性前缀。

属性描述默认值
spring.ai.zhipuai.embedding.enabled启用 ZhiPuAI 嵌入模型。true
spring.ai.zhipuai.embedding.base-url可选，覆盖 spring.ai.zhipuai.base-url 以提供特定于嵌入的 URL-
spring.ai.zhipuai.embedding.api-key可选，覆盖 spring.ai.zhipuai.api-key 以提供特定于嵌入的 API 密钥-
spring.ai.zhipuai.embedding.options.model使用的模型embedding-2
spring.ai.zhipuai.embedding.options.dimensions维度数量，当模型为 embedding-3 时，默认值为 2048-
备注

你可以为 ChatModel 和 EmbeddingModel 实现覆盖通用的 spring.ai.zhipuai.base-url 和 spring.ai.zhipuai.api-key。如果设置了 spring.ai.zhipuai.embedding.base-url 和 spring.ai.zhipuai.embedding.api-key 属性，它们将优先于通用属性。同样，如果设置了 spring.ai.zhipuai.chat.base-url 和 spring.ai.zhipuai.chat.api-key 属性，它们也将优先于通用属性。这在你想为不同的模型和不同的模型端点使用不同的 ZhiPuAI 账户时非常有用。

提示

所有以 spring.ai.zhipuai.embedding.options 为前缀的属性都可以通过在 EmbeddingRequest 调用中添加特定请求的运行时选项来在运行时覆盖。

运行时选项​

ZhiPuAiEmbeddingOptions.java 提供了 ZhiPuAI 的配置选项，例如使用的模型等。

默认选项也可以通过 spring.ai.zhipuai.embedding.options 属性进行配置。

在启动时，使用 ZhiPuAiEmbeddingModel 构造函数来设置用于所有嵌入请求的默认选项。在运行时，你可以通过使用 ZhiPuAiEmbeddingOptions 实例作为 EmbeddingRequest 的一部分来覆盖默认选项。

例如，要为特定请求覆盖默认的模型名称：

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        ZhiPuAiEmbeddingOptions.builder()
            .model("Different-Embedding-Model-Deployment-Name")
        .build()));
java

示例控制器​

这将创建一个 EmbeddingModel 实现，你可以将其注入到你的类中。以下是一个使用 EmbeddingModel 实现的简单 @Controller 类示例。

spring.ai.zhipuai.api-key=YOUR_API_KEY
spring.ai.zhipuai.embedding.options.model=embedding-2
application.properties
@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);
    }
}
java

手动配置​

如果你没有使用 Spring Boot，你可以手动配置 ZhiPuAI Embedding 模型。为此，请将 spring-ai-zhipuai 依赖添加到你的项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-zhipuai</artifactId>
</dependency>
xml

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}
groovy
提示

请参考 依赖管理 部分，将 Spring AI BOM 添加到你的构建文件中。

备注

spring-ai-zhipuai 依赖还提供了对 ZhiPuAiChatModel 的访问。有关 ZhiPuAiChatModel 的更多信息，请参阅 ZhiPuAI 聊天客户端 部分。

接下来，创建一个 ZhiPuAiEmbeddingModel 实例，并使用它来计算两个输入文本之间的相似度：

var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));

var embeddingModel = new ZhiPuAiEmbeddingModel(api, MetadataMode.EMBED,
				ZhiPuAiEmbeddingOptions.builder()
						.model("embedding-3")
						.dimensions(1536)
						.build());

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

ZhiPuAiEmbeddingOptions 提供了用于嵌入请求的配置信息。该选项类提供了一个 builder() 方法，以便轻松创建选项。