智谱AI 向量模型
Spring AI 支持智谱AI的文本嵌入模型。 智谱AI的文本嵌入模型衡量文本字符串的相关性。 嵌入是一个浮点数向量(列表)。两个向量之间的距离衡量它们的相关性。小距离表示高相关性,大距离表示低相关性。
先决条件
您需要使用智谱AI创建一个API才能访问智谱AI语言模型。
在智谱AI注册页面创建一个帐户,并在API密钥页面生成令牌。
Spring AI项目定义了一个名为spring.ai.zhipu.api-key
的配置属性,您应该将其设置为从API密钥页面获取的API Key
的值。
您可以在application.properties
文件中设置此配置属性:
为了在处理API密钥等敏感信息时增强安全性,您可以使用Spring表达式语言(SpEL)引用环境变量:
您还可以在应用程序代码中以编程方式设置此配置:
添加仓库和BOM
Spring AI的构件发布在Maven Central和Spring Snapshot仓库中。 请参阅构件仓库部分,将这些仓库添加到您的构建系统中。
为了帮助进行依赖管理,Spring AI提供了一个BOM(物料清单),以确保在整个项目中都使用一致的Spring AI版本。请参阅依赖管理部分,将Spring AI BOM添加到您的构建系统中。
自动配置
Spring AI自动配置、启动器模块的构件名称已发生重大更改。 有关更多信息,请参阅升级说明。
Spring AI为智谱AI Embedding模型提供Spring Boot自动配置。
要启用它,请将以下依赖项添加到项目的Maven pom.xml
文件中:
或添加到您的Gradle build.gradle
构建文件中。
请参阅依赖管理部分,将Spring AI BOM添加到您的构建文件中。
Embedding属性
重试属性
前缀spring.ai.retry
用作属性前缀,可让您配置智谱AI Embedding模型的重试机制。
属性 | 描述 | 默认值 |
---|---|---|
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,并且不尝试对4xx 客户端错误代码进行重试。 | 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。 | https://open.bigmodel.cn/api/paas |
spring.ai.zhipuai.api-key | API密钥。 | - |
配置属性
Embedding自动配置的启用和禁用现在通过前缀为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 Embedding模型。 | true |
spring.ai.model.embedding | 启用智谱AI Embedding模型。 | zhipuai |
spring.ai.zhipuai.embedding.base-url | 可选,覆盖spring.ai.zhipuai.base-url以提供特定于Embedding的URL。 | - |
spring.ai.zhipuai.embedding.api-key | 可选,覆盖spring.ai.zhipuai.api-key以提供特定于Embedding的API密钥。 | - |
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
调用添加特定于请求的Embedding选项来覆盖。
运行时选项
ZhiPuAiEmbeddingOptions.java提供了智谱AI的配置,例如要使用的模型等。
默认选项也可以使用spring.ai.zhipuai.embedding.options
属性进行配置。
在启动时,使用ZhiPuAiEmbeddingModel
构造函数设置用于所有Embedding请求的默认选项。
在运行时,您可以通过在EmbeddingRequest
中使用ZhiPuAiEmbeddingOptions
实例来覆盖默认选项。
例如,要覆盖特定请求的默认模型名称:
示例控制器
这将创建一个EmbeddingModel
实现,您可以将其注入到您的类中。
这是一个简单的@Controller
类的示例,它使用EmbeddingModel
实现。
手动配置
如果您不使用Spring Boot,则可以手动配置智谱AI Embedding模型。
为此,请将spring-ai-zhipuai
依赖项添加到项目的Maven pom.xml
文件中:
或添加到您的Gradle build.gradle
构建文件中。
请参阅依赖管理部分,将Spring AI BOM添加到您的构建文件中。
spring-ai-zhipuai
依赖项还提供对ZhiPuAiChatModel
的访问。
有关ZhiPuAiChatModel
的更多信息,请参阅智谱AI聊天客户端部分。
接下来,创建一个ZhiPuAiEmbeddingModel
实例,并使用它来计算两个输入文本之间的相似度:
ZhiPuAiEmbeddingOptions
为Embedding请求提供配置信息。
该选项类提供了一个builder()
,以便轻松创建选项。
文档有误?请协助编辑
发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!