智谱AI Embeddings
Spring AI 支持智谱AI的文本嵌入模型。 智谱AI的文本嵌入用于测量文本字符串之间的相关性。 嵌入是一个浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。距离小表示高度相关，距离大表示低相关性。
前提条件
您需要创建智谱AI的API来访问智谱AI语言模型。
Spring AI项目定义了一个名为`spring.ai.zhipu.api-key`的配置属性，您应该将其设置为从API密钥页面获取的`API Key`值。
您可以在`application.properties`文件中设置此配置属性：
spring.ai.zhipu.api-key=<your-zhipu-api-key>为了增强处理敏感信息（如API密钥）时的安全性，您可以使用Spring表达式语言（SpEL）引用环境变量：
# 在application.yml中
spring:
ai:
zhipu:
api-key: ${ZHIPU_API_KEY}# 在您的环境或.env文件中
export ZHIPU_API_KEY=<your-zhipu-api-key>您也可以在应用程序代码中以编程方式设置此配置：
// 从安全源或环境变量获取API密钥
String apiKey = System.getenv("ZHIPU_API_KEY");自动配置
|
Spring AI自动配置、starter模块的构件名称发生了重大变化。 请参考https://docs.spring.io/spring-ai/reference/upgrade-notes.html[升级说明]获取更多信息。 |
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，对于`4xx`客户端错误代码抛出NonTransientAiException，不尝试重试 |
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 |
|
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-key |
- |
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`构造函数设置用于所有嵌入请求的默认选项。 在运行时，您可以使用`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()));示例控制器
这将创建一个`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嵌入模型。 为此，请在项目的Maven `pom.xml`文件中添加`spring-ai-zhipuai`依赖：
<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`提供嵌入请求的配置信息。 options类提供了一个`builder()`用于轻松创建选项。
