智谱AI 嵌入式模型

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

先决条件

您需要向智谱AI 创建一个 API 来访问智谱AI 语言模型。

在智谱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>

添加仓库和 BOM

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

为了帮助依赖管理，Spring AI 提供了一个 BOM (bill of materials) 以确保整个项目中使用的 Spring AI 版本一致。请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建系统中。

自动配置

Spring AI 自动配置、启动模块的工件名称发生了重大变化。有关更多信息，请参阅升级说明。

Spring AI 为 Azure 智谱AI 嵌入式模型提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中

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

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

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

嵌入式属性

重试属性

前缀 spring.ai.retry 用作属性前缀，允许您配置智谱AI 嵌入式模型的重试机制。

属性 描述 默认值

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 用作属性前缀，允许您连接到智谱AI。

属性 描述 默认值

spring.ai.zhipuai.base-url

连接 URL

open.bigmodel.cn/api/paas

spring.ai.zhipuai.api-key

API 密钥

-

配置属性

嵌入式自动配置的启用和禁用现在通过带有前缀 spring.ai.model.embedding 的顶级属性进行配置。

要启用，设置 spring.ai.model.embedding=zhipuai (默认已启用)

要禁用，设置 spring.ai.model.embedding=none (或任何与 zhipuai 不匹配的值)

此更改是为了支持配置多个模型。

前缀 spring.ai.zhipuai.embedding 是配置智谱AI 的 EmbeddingModel 实现的属性前缀。

属性 描述 默认值

spring.ai.zhipuai.embedding.enabled (已移除，不再有效)

启用智谱AI 嵌入式模型。

true

spring.ai.model.embedding

启用智谱AI 嵌入式模型。

zhipuai

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 属性，则它们优先于通用属性。这在您想为不同的模型和不同的模型端点使用不同的智谱AI 账户时很有用。
所有带有 spring.ai.zhipuai.embedding.options 前缀的属性都可以通过在 EmbeddingRequest 调用中添加请求特定的运行时选项来覆盖默认值。

运行时选项

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

也可以使用 spring.ai.zhipuai.embedding.options 属性配置默认选项。

在启动时使用 ZhiPuAiEmbeddingModel 构造函数设置所有嵌入请求使用的默认选项。在运行时，您可以使用 EmbeddingRequest 中的 ZhiPuAiEmbeddingOptions 实例覆盖默认选项。

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

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()));

示例控制器

这将创建一个 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(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"));

ZhiPuAiEmbeddingOptions 提供了嵌入式请求的配置信息。选项类提供了 builder() 以方便创建选项。