ZhiPuAI Embeddings
Spring AI 支持智谱AI的文本嵌入模型。智谱AI的文本嵌入用于衡量文本字符串之间的相关性。嵌入是一个浮点数组成的向量（列表）。两个向量之间的距离衡量它们的相关性，距离越小表示相关性越高，距离越大表示相关性越低。
前提条件
您需要创建一个API来连接智谱AI，以便访问智谱AI的语言模型。
在 智谱AI注册页面 创建账户，并在 API Keys 页面 生成 token。
Spring AI 项目定义了一个名为 spring.ai.zhipuai.api-key 的配置属性，你应将其设置为从 API Keys 页面获取的 API Key 的值。
您可以在 application.properties 文件中设置此配置属性：
spring.ai.zhipuai.api-key=<your-zhipuai-api-key>
为了在处理敏感信息（如 API 密钥）时增强安全性，你可以使用 Spring 表达式语言（SpEL）来引用环境变量：
# In application.yml
spring:
ai:
zhipuai:
api-key: ${ZHIPUAI_API_KEY}
# In your environment or .env file
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>
你也可以在应用程序代码中以编程方式设置此配置：
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");
添加仓库和物料清单（BOM）
Spring AI 组件已发布至 Maven Central 和 Spring Snapshot 仓库。请参考构件仓库章节，将这些仓库添加至您的构建系统中。
为帮助进行依赖管理，Spring AI 提供了物料清单（BOM）以确保在整个项目中使用的 Spring AI 版本一致。请参阅依赖管理部分，将 Spring AI BOM 添加到您的构建系统中。
Auto-configuration
Spring AI 的自动配置与 starter 模块的 artifact 名称发生了重大变化。更多信息请参阅 升级说明。
Spring AI 为 Azure ZhiPuAI 嵌入模型提供了 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，对于 4xx 客户端错误码，会抛出 NonTransientAiException，且不进行重试尝试。 | 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.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物料清单添加到您的构建文件中。
:::
spring-ai-zhipuai 依赖也提供了对 ZhiPuAiChatModel 的访问。有关 ZhiPuAiChatModel 的更多信息，请参阅 智谱 AI 聊天客户端 章节。
接下来，创建一个 ZhiPuAiEmbeddingModel 实例，并使用它来计算两个输入文本之间的相似度：
var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPUAI_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() 方法，以便轻松创建选项。