ZhiPuAI 嵌入
Spring AI 支持 ZhiPuAI 的文本嵌入模型。 ZhiPuAI 的文本嵌入向量可以测量文本字符串的相关性。 嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。小距离表示高相关性，大距离表示低相关性。
先决条件
您需要使用 ZhiPuAI 创建 API 才能访问 ZhiPu AI 语言模型。
在 智普 AI 注册页面创建账号，并在 API Keys 页面生成 Token。
Spring AI 项目定义了一个名为spring.ai.zhipu.api-key，您应该设置为API Key从 API 密钥页面获取。
导出环境变量是设置该配置属性的一种方法：
export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>添加存储库和 BOM
Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理，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>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
嵌入属性
重试属性
前缀spring.ai.retry用作属性前缀，用于配置 ZhiPuAI 嵌入模型的重试机制。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
3 分钟 |
spring.ai.retry.on-client-errors |
如果为 false，则抛出 NonTransientAiException，并且不要尝试重试 |
假 |
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 |
|
spring.ai.zhipuai.api-key |
API 密钥 |
- |
配置属性
前缀spring.ai.zhipuai.embedding是属性前缀，该前缀配置EmbeddingModelZhiPuAI 的实现。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.zhipuai.embedding.enabled |
启用 ZhiPuAI 嵌入模型。 |
真 |
spring.ai.zhipuai.embedding.base-url |
可选覆盖spring.ai.zhipuai.base-url以提供嵌入特定的url |
- |
spring.ai.zhipuai.embedding.api-key |
Optional 覆盖 spring.ai.zhipuai.api-key 以提供嵌入特定的 api-key |
- |
spring.ai.zhipuai.embedding.options.model |
要使用的模型 |
嵌入 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如果设置了 properties，则优先于 common properties。
同样，spring.ai.zhipuai.chat.base-url和spring.ai.zhipuai.chat.api-key如果设置了 properties，则优先于 common properties。
如果您想为不同的模型和不同的模型终端节点使用不同的 ZhiPuAI 帐户，这将非常有用。 |
所有前缀为spring.ai.zhipuai.embedding.options可以通过将特定于请求的运行时选项添加到EmbeddingRequest叫。 |
运行时选项
ZhiPuAiEmbeddingOptions.java提供了 ZhiPuAI 的配置，例如要使用的模型等。
默认选项可以使用spring.ai.zhipuai.embedding.optionsproperties 也是如此。
启动时，使用ZhiPuAiEmbeddingModelconstructor 设置用于所有嵌入请求的默认选项。
在运行时，您可以使用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()));Samples控制器
这将创建一个EmbeddingModel实现，您可以将其注入到您的类中。
下面是一个简单的示例@Controller类使用EmbeddingModel实现。
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，可以手动配置 ZhiPuAI Embedding Model。
为此，请添加spring-ai-zhipuai依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-zhipuai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-zhipuai'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
这spring-ai-zhipuaidependency 还提供对ZhiPuAiChatModel.
有关ZhiPuAiChatModel请参考 ZhiPuAI 聊天客户端 部分。 |
接下来，创建一个ZhiPuAiEmbeddingModel实例，并使用它来计算两个输入文本之间的相似性：
var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));
var embeddingModel = new ZhiPuAiEmbeddingModel(this.zhiPuAiApi)
.withDefaultOptions(ZhiPuAiChatOptions.build()
.withModel("embedding-2")
.build());
EmbeddingResponse embeddingResponse = this.embeddingModel
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));这ZhiPuAiEmbeddingOptions提供嵌入请求的配置信息。
options 类提供了一个builder()轻松创建选项。