智谱AI嵌入
Spring AI 支持智谱AI的文本嵌入模型。智谱AI的文本嵌入衡量文本字符串的相关性。嵌入是一个浮点数向量（列表）。两个向量之间的距离衡量它们的相关性。小的距离表示高度相关，大的距离表示低相关性。
先决条件
自动配置
Spring AI 为 Azure 智谱AI嵌入模型提供了 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 用作属性前缀，允许您配置智谱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，并且不尝试针对 |
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.zhipuai.embedding 是配置智谱AI的EmbeddingModel实现的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.zhipuai.embedding.enabled |
启用智谱AI嵌入模型。 |
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-key |
- |
spring.ai.zhipuai.embedding.options.model |
要使用的模型 |
embedding-2 |
您可以为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()
.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，您可以手动配置ZhiPuAI Embedding Model。为此，请将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的更多信息，请参阅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提供嵌入请求的配置信息。选项类提供了一个builder()用于轻松创建选项。
