ZhiPuAI 嵌入
Spring AI 支持 ZhiPuAI 的文本嵌入模型。 ZhiPuAI 的文本嵌入衡量文本字符串的相关性。 嵌入是浮点数的向量(列表)。两个向量之间的距离衡量它们的相关性。小距离表示高相关性,大距离表示低相关性。
前提条件
您需要使用 ZhiPuAI 创建 API 才能访问 ZhiPu AI 语言模型。
在智谱AI注册页面创建账号,在API Keys页面生成Tokens。
Spring AI 项目定义了一个名为spring.ai.zhipu.api-key
您应该将API Key
从 API 密钥页面获取。
您可以在application.properties
文件:
spring.ai.zhipu.api-key=<your-zhipu-api-key>
为了在处理 API 密钥等敏感信息时增强安全性,您可以使用 Spring 表达式语言 (SpEL) 来引用环境变量:
# In application.yml
spring:
ai:
zhipu:
api-key: ${ZHIPU_API_KEY}
# In your environment or .env file
export ZHIPU_API_KEY=<your-zhipu-api-key>
您还可以在应用程序代码中以编程方式设置此配置:
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPU_API_KEY");
添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Artifact Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖管理,Spring AI 提供了 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 自动配置、入门模块的工件名称发生了重大变化。有关更多信息,请参阅升级说明。 |
Spring AI 为 Azure ZhiPuAI 嵌入模型提供 Spring Boot 自动配置。
要启用它,请将以下依赖项添加到项目的 Mavenpom.xml
文件:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-zhipuai</artifactId>
</dependency>
或 Gradlebuild.gradle
构建文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}
请参阅依赖项管理部分,将 Spring AI BOM 添加到构建文件中。 |
嵌入属性
重试属性
前缀spring.ai.retry
用作属性前缀,用于配置 ZhiPuAI Embedding 模型的重试机制。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.retry.max次尝试 |
重试尝试的最大次数。 |
10 |
spring.ai.retry.backoff.初始间隔 |
指数退避策略的初始睡眠持续时间。 |
2 秒。 |
spring.ai.retry.backoff.乘数 |
回退间隔乘数。 |
5 |
spring.ai.retry.backoff.max间隔 |
最大回退持续时间。 |
3分钟 |
spring.ai.retry.on-client-错误 |
如果为 false,则引发 NonTransientAiException,并且不要尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。 |
empty |
spring.ai.retry.on-http-代码 |
应触发重试的 HTTP 状态代码列表(例如,抛出 TransientAiException)。 |
empty |
连接属性
前缀spring.ai.zhipuai
用作允许您连接到 ZhiPuAI 的属性前缀。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.zhipuai.base-url |
要连接到的 URL |
|
spring.ai.zhipuai.api-key |
API 密钥 |
- |
配置属性
现在,通过前缀 要启用,spring.ai.model.embedding=zhipuai(默认启用) 要禁用,spring.ai.model.embedding=none(或任何与zhipuai不匹配的值) 进行此更改是为了允许配置多个模型。 |
前缀spring.ai.zhipuai.embedding
是配置EmbeddingModel
ZhiPuAI 的实施。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.zhipuai.embedding.enabled(已删除且不再有效) |
启用 ZhiPuAI 嵌入模型。 |
true |
spring.ai.model.embedding |
启用 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 |
要使用的模型 |
嵌入-2 |
spring.ai.zhipuai.embedding.options.dimensions |
维数,模型嵌入时默认值为2048-3 |
- |
您可以覆盖通用的spring.ai.zhipuai.base-url 和spring.ai.zhipuai.api-key 对于ChatModel 和EmbeddingModel 实现。
这spring.ai.zhipuai.embedding.base-url 和spring.ai.zhipuai.embedding.api-key 如果设置了属性,则优先于通用属性。
同样,spring.ai.zhipuai.chat.base-url 和spring.ai.zhipuai.chat.api-key 如果设置了属性,则优先于通用属性。
如果您想为不同的模型和不同的模型端点使用不同的 ZhiPuAI 帐户,这非常有用。 |
所有以spring.ai.zhipuai.embedding.options 可以通过将特定于请求的运行时选项添加到EmbeddingRequest 叫。 |
运行时选项
ZhiPuAiEmbeddingOptions.java提供了 ZhiPuAI 的配置,例如要使用的模型等。
可以使用spring.ai.zhipuai.embedding.options
属性也是如此。
在开始时使用ZhiPuAiEmbeddingModel
constructor 来设置用于所有嵌入请求的默认选项。
在运行时,您可以使用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()));
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 嵌入模型。
为此,将spring-ai-zhipuai
对项目 Maven 的依赖pom.xml
文件:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-zhipuai</artifactId>
</dependency>
或 Gradlebuild.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(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()
以便于创建期权。