|
最新快照版本请使用Spring AI 1.1.0！ |
ZhiPuAI 嵌入
Spring AI 支持 ZhiPuAI 的文本嵌入模型。 ZhPuAI的文本嵌入测量文本字符串的相关性。 嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。距离较小表示高度相关性，较大距离表示高度相关性。
前提条件
你需要用 ZhiPuAI 创建一个 API 来访问 ZhiPu 的 AI 语言模型。
在ZhiPu AI注册页面创建账户，并在API密钥页面生成Tokens。
Spring AI 项目定义了一个配置属性，名为spring.ai.zhipu.api-key。你应该设置为API 密钥获取自 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");自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 Azure ZhiPuAI 嵌入模型提供 Spring Boot 自动配置。
要启用它，请在项目的Maven中添加以下依赖pom.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的物料清单添加到你的构建文件中。 |
嵌入性质
重试属性
前缀spring.ai.retry作为属性前缀，允许你配置ZhiPuAI嵌入模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.retry.max尝试 |
重试次数上限。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数式退避政策的初始睡眠时长。 |
两秒钟。 |
spring.ai.retry.backoff.multiplier |
后退间隔倍数。 |
5 |
spring.ai.retry.backoff.max区间 |
最大退回时间。 |
3分钟。 |
spring.ai.retry.on-client-errors |
如果为假，抛出非瞬态AiException，且不要尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应该触发重试的HTTP状态码列表（例如抛出非瞬态Ai异常）。 |
empty |
spring.ai.retry.on-http-codes |
应触发重试的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（或任何与 zipuai 不匹配的值） 此改动旨在允许配置多个模型。 |
前缀spring.ai.zhipuai.embedding是配置嵌入模型ZiPuAI的实现。
| 属性 | 描述 | 默认值 |
|---|---|---|
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 |
维数，当模型嵌入为3时，默认值为2048 |
- |
你可以覆盖公共信息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。如果设置了属性，属性优先于常见属性。
如果你想为不同模型和不同模型端点使用不同的ZhiPuAI账户，这非常有用。 |
运行时选项
ZhiPuAiEmbeddingOptions.java提供ZhiPuAI配置，如所用模型等。
默认选项可以通过以下方式配置spring.ai.zhipuai.embedding.options房产也是。
在开始时使用志普爱嵌入模型构建器（constructor）来设置所有嵌入请求的默认选项。
运行时你可以通过志普爱嵌入选项实例作为你的一部分嵌入请求.
例如，要覆盖特定请求的默认型号名称：
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()));采样控制器
这将产生嵌入模型你可以把这些实现注入到你的类里。
这里有一个简单的例子@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 嵌入模型。
为此添加春艾志卜艾对你项目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的物料清单添加到你的构建文件中。 |
这春艾志卜艾依赖还提供访问ZhPuAiChat模型. 欲了解更多关于ZhPuAiChat模型请参阅ZhiPuAI聊天客户端部分。 |
接下来，创建一个志普爱嵌入模型实例并用它来计算两个输入文本之间的相似性：
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"));这志普爱嵌入选项提供嵌入请求的配置信息。
期权类提供架构商（）方便创建期权。