智谱AI Embeddings

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

先决条件

您需要创建一个 API 与智谱AI 连接以访问智谱AI 语言模型。

在 智谱AI 注册页面 创建一个帐户，并在 API 密钥页面 上生成令牌。Spring AI 项目定义了一个名为 spring.ai.zhipu.api-key 的配置属性，您应该将其设置为从 API 密钥页面 获取的 API 密钥 的值。导出环境变量是设置该配置属性的一种方法

export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 存储库 部分，将这些存储库添加到您的构建系统中。

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

自动配置

Spring AI 为 Azure ZhiPuAI 嵌入客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中

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

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}
请参考 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

重试属性

前缀 spring.ai.retry 用作属性前缀，允许您配置 ZhiPuAI 嵌入客户端的重试机制。

属性 描述 默认值

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

要连接到的 URL

open.bigmodel.cn/api/paas

spring.ai.zhipuai.api-key

API 密钥

-

配置属性

前缀 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.base-url 和 spring.ai.zhipuai.api-key 用于 ChatModel 和 EmbeddingModel 实现。如果设置了 spring.ai.zhipuai.embedding.base-url 和 spring.ai.zhipuai.embedding.api-key 属性，则优先于通用属性。类似地，如果设置了 spring.ai.zhipuai.embedding.base-url 和 spring.ai.zhipuai.embedding.api-key 属性，则优先于通用属性。如果您想对不同的模型和不同的模型端点使用不同的智谱 AI 帐户，这将很有用。
所有以 spring.ai.zhipuai.embedding.options 为前缀的属性都可以在运行时通过在 EmbeddingRequest 调用中添加特定于请求的 运行时选项 来覆盖。

运行时选项

该 ZhiPuAiEmbeddingOptions.java 提供了智谱 AI 配置，例如要使用的模型等。

默认选项也可以使用 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()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器

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

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

手动配置

如果您没有使用 Spring Boot，则可以手动配置智谱 AI 嵌入客户端。为此，将 spring-ai-zhipuai 依赖项添加到项目的 Maven pom.xml 文件中

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

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}
请参考 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。
spring-ai-zhipuai 依赖项还提供对 ZhiPuAiChatModel 的访问。有关 ZhiPuAiChatModel 的更多信息，请参阅 智谱 AI 聊天客户端 部分。

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

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

var embeddingModel = new ZhiPuAiEmbeddingModel(zhiPuAiApi)
    .withDefaultOptions(ZhiPuAiChatOptions.build()
        .withModel("embedding-2")
        .build());

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

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