前提条件
你需要使用智谱 AI 创建一个 API 才能访问智谱 AI 语言模型。 在智谱 AI 注册页面创建一个帐户,并在API 密钥页面生成令牌。 Spring AI 项目定义了一个名为spring.ai.zhipuai.api-key 的配置属性,你应该将其设置为从 API 密钥页面获取的 API 密钥 的值。
你可以在 application.properties 文件中设置此配置属性:
添加仓库和 BOM
Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅构件仓库部分,将这些仓库添加到你的构建系统中。 为了帮助进行依赖管理,Spring AI 提供了一个 BOM (bill of materials),以确保在整个项目中使用一致版本的 Spring AI。请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建系统中。自动配置
:::note Spring AI 自动配置、启动器模块的构件名称发生了重大变化。 有关更多信息,请参阅升级说明。 ::: Spring AI 为智谱 AI 聊天客户端提供 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Mavenpom.xml 文件中:
build.gradle 构建文件中。
聊天属性
重试属性
前缀spring.ai.retry 用作属性前缀,允许你配置智谱 AI 聊天模型的重试机制。
连接属性
前缀spring.ai.zhiPu 用作属性前缀,允许你连接到智谱 AI。
配置属性
:::note 聊天自动配置的启用和禁用现在通过前缀为spring.ai.model.chat 的顶级属性进行配置。
要启用,spring.ai.model.chat=zhipuai (默认启用)
要禁用,spring.ai.model.chat=none (或任何与 zhipuai 不匹配的值)
此更改是为了允许配置多个模型。
:::
前缀 spring.ai.zhipuai.chat 是属性前缀,允许你配置智谱 AI 的聊天模型实现。
:::note
你可以为
ChatModel 实现覆盖通用的 spring.ai.zhipuai.base-url 和 spring.ai.zhipuai.api-key。
如果设置了 spring.ai.zhipuai.chat.base-url 和 spring.ai.zhipuai.chat.api-key 属性,则它们优先于通用属性。
如果你想为不同的模型和不同的模型端点使用不同的智谱 AI 帐户,这将非常有用。
:::
:::tip
所有以 spring.ai.zhipuai.chat.options 为前缀的属性都可以在运行时通过向 Prompt 调用添加特定于请求的聊天选项来覆盖。
:::
运行时选项
ZhiPuAiChatOptions.java 提供模型配置,例如要使用的模型、温度、频率惩罚等。 在启动时,可以使用ZhiPuAiChatModel(api, options) 构造函数或 spring.ai.zhipuai.chat.options.* 属性配置默认选项。
在运行时,你可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要为特定请求覆盖默认模型和温度:
示例控制器
创建一个新的 Spring Boot 项目,并将spring-ai-starter-model-zhipuai 添加到你的 pom (或 gradle) 依赖项中。
在 src/main/resources 目录下添加一个 application.properties 文件,以启用和配置智谱 AI 聊天模型:
api-key 替换为你的智谱 AI 凭据。
:::
这将创建一个 ZhiPuAiChatModel 实现,你可以将其注入到你的类中。
以下是一个简单的 @Controller 类的示例,该类使用聊天模型进行文本生成。
手动配置
ZhiPuAiChatModel.java 实现了ChatModel 和 StreamingChatModel,并使用低级 API连接到智谱 AI 服务。
将 spring-ai-zhipuai 依赖项添加到项目的 Maven pom.xml 文件中:
build.gradle 构建文件中。
ZhiPuAiChatModel 并将其用于文本生成:
ZhiPuAiChatOptions 为聊天请求提供配置信息。
ZhiPuAiChatOptions.Builder 是流畅的选项构建器。
低级智谱 AI API 客户端
ZhiPuAiApi.java 提供了轻量级的 Java 客户端,用于智谱 AI API。 以下是一个简单的代码片段,展示了如何以编程方式使用 API:智谱 AI API 示例
- ZhiPuAiApiIT.java 测试提供了一些有关如何使用轻量级库的常规示例。
文档有误?请协助编辑
发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!