此版本仍在开发中,尚不被认为是稳定的。对于最新的快照版本,请使用 Spring AI 1.0.1! |
智谱AI聊天
Spring AI 支持 ZhiPu AI 的各种 AI 语言模型。您可以与 ZhiPu AI 语言模型进行交互,并创建基于 ZhiPuAI 模型的多语言对话助手。
前提条件
您需要使用 ZhiPuAI 创建 API 才能访问 ZhiPu AI 语言模型。
在智谱AI注册页面创建账号,在API Keys页面生成Tokens。
Spring AI 项目定义了一个名为spring.ai.zhipuai.api-key
您应该将API Key
从 API 密钥页面获取。
您可以在application.properties
文件:
spring.ai.zhipuai.api-key=<your-zhipuai-api-key>
为了在处理 API 密钥等敏感信息时增强安全性,您可以使用 Spring Expression Language (SpEL) 来引用自定义环境变量:
# In application.yml
spring:
ai:
zhipuai:
api-key: ${ZHIPUAI_API_KEY}
# In your environment or .env file
export ZHIPUAI_API_KEY=<your-zhipuai-api-key>
您还可以在应用程序代码中以编程方式设置此配置:
// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");
添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Artifact Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖管理,Spring AI 提供了 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 自动配置、入门模块的工件名称发生了重大变化。 有关更多信息,请参阅升级说明。 |
Spring AI 为 ZhiPuAI Chat 客户端提供 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
用作属性前缀,用于配置 ZhiPu AI 聊天模型的重试机制。
属性 | 描述 | 默认值 |
---|---|---|
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.zhiPu
用作允许您连接到 ZhiPuAI 的属性前缀。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.zhipuai.base-url |
要连接到的 URL |
|
spring.ai.zhipuai.api-key |
API 密钥 |
- |
配置属性
现在,通过前缀为 要启用,spring.ai.model.chat=zhipuai(默认启用) 要禁用,spring.ai.model.chat=none(或任何与zhipuai不匹配的值) 进行此更改是为了允许配置多个模型。 |
前缀spring.ai.zhipuai.chat
是用于配置 ZhiPuAI 聊天模型实现的属性前缀。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.zhipuai.chat.enabled(已删除且不再有效) |
启用 ZhiPuAI 聊天模型。 |
true |
spring.ai.model.聊天 |
启用 ZhiPuAI 聊天模型。 |
智浦 |
spring.ai.zhipuai.chat.base-url |
可选覆盖spring.ai.zhipuai.base-url以提供特定于聊天的URL |
|
spring.ai.zhipuai.chat.api-key |
可选覆盖spring.ai.zhipuai.api-key以提供特定于聊天的api-key |
- |
spring.ai.zhipuai.chat.options.model |
这是要使用的 ZhiPuAI Chat 模型 |
|
spring.ai.zhipuai.chat.options.maxTokens |
聊天补全时要生成的最大Tokens数。输入标记和生成标记的总长度受模型上下文长度的限制。 |
- |
spring.ai.zhipuai.chat.options.温度 |
使用什么采样温度,介于 0 和 1 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使其更加集中和确定。我们通常建议更改此或top_p但不要同时更改两者。 |
0.7 |
spring.ai.zhipuai.chat.options.topP |
温度采样的替代方法称为核采样,其中模型考虑具有top_p概率质量的标记的结果。因此,0.1 意味着仅考虑包含前 10% 概率质量的Tokens。我们通常建议改变这个或温度,但不要同时改变两者。 |
1.0 |
spring.ai.zhipuai.chat.options.stop |
模型将停止生成 stop 指定的字符,目前仅支持格式为 [“stop_word1”] 的单个停用词 |
- |
spring.ai.zhipuai.chat.options.user |
代表最终用户的唯一标识符,可以帮助智普人工智能监控和检测滥用行为。 |
- |
spring.ai.zhipuai.chat.options.requestId |
该参数由客户端传递,必须保证唯一性。它用于区分每个请求的唯一标识符。如果客户端不提供,平台将默认生成它。 |
- |
spring.ai.zhipuai.chat.options.do示例 |
当do_sample设置为 true 时,将启用采样策略。如果 do_sample 为 false,则采样策略参数 temperature 和 top_p 将不会生效。 |
true |
spring.ai.zhipuai.chat.options.proxy-tool-calls |
如果为 true,则 Spring AI 不会在内部处理函数调用,而是将它们代理到客户端。然后,客户端负责处理函数调用,将它们分派到适当的函数,并返回结果。如果为 false(默认值),则 Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型 |
false |
您可以覆盖通用的spring.ai.zhipuai.base-url 和spring.ai.zhipuai.api-key 对于ChatModel 实现。 这spring.ai.zhipuai.chat.base-url 和spring.ai.zhipuai.chat.api-key 如果设置了属性,则优先于公共属性。如果您想为不同的模型和不同的模型端点使用不同的 ZhiPuAI 帐户,这将非常有用。 |
所有以spring.ai.zhipuai.chat.options 可以通过将特定于请求的运行时选项添加到Prompt 叫。 |
运行时选项
ZhiPuAiChatOptions.java提供模型配置,例如要使用的模型、温度、频率惩罚等。
启动时,可以使用ZhiPuAiChatModel(api, options)
构造函数或spring.ai.zhipuai.chat.options.*
性能。
在运行时,您可以通过向Prompt
叫。 例如,要覆盖特定请求的默认模型和温度,请执行以下作:
ChatResponse response = chatModel.call(
new Prompt(
"Generate the names of 5 famous pirates.",
ZhiPuAiChatOptions.builder()
.model(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
.temperature(0.5)
.build()
));
除了特定于模型的 ZhiPuAiChatOptions 之外,您还可以使用使用 ChatOptions#builder() 创建的可移植 ChatOptions 实例。 |
Samples控制器
创建一个新的 Spring Boot 项目,并将spring-ai-starter-model-zhipuai
到你的 pom(或 gradle)依赖项。
添加一个application.properties
文件,在src/main/resources
目录下,开启和配置知普爱聊天模型:
spring.ai.zhipuai.api-key=YOUR_API_KEY
spring.ai.zhipuai.chat.options.model=glm-4-air
spring.ai.zhipuai.chat.options.temperature=0.7
将api-key 使用您的 ZhiPuAI 凭证。 |
这将创建一个ZhiPuAiChatModel
实现,您可以注入到类中。
这是一个简单的示例@Controller
使用聊天模型生成文本的类。
@RestController
public class ChatController {
private final ZhiPuAiChatModel chatModel;
@Autowired
public ChatController(ZhiPuAiChatModel chatModel) {
this.chatModel = chatModel;
}
@GetMapping("/ai/generate")
public Map generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
return Map.of("generation", this.chatModel.call(message));
}
@GetMapping(value = "/ai/generateStream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
var prompt = new Prompt(new UserMessage(message));
return this.chatModel.stream(prompt);
}
}
手动配置
ZhiPuAiChatModel 实现了ChatModel
和StreamingChatModel
并使用低级 ZhiPuAiApi 客户端连接到 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 添加到构建文件中。 |
接下来,创建一个ZhiPuAiChatModel
并将其用于文本生成:
var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));
var chatModel = new ZhiPuAiChatModel(this.zhiPuAiApi, ZhiPuAiChatOptions.builder()
.model(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
.temperature(0.4)
.maxTokens(200)
.build());
ChatResponse response = this.chatModel.call(
new Prompt("Generate the names of 5 famous pirates."));
// Or with streaming responses
Flux<ChatResponse> streamResponse = this.chatModel.stream(
new Prompt("Generate the names of 5 famous pirates."));
这ZhiPuAiChatOptions
提供聊天请求的配置信息。
这ZhiPuAiChatOptions.Builder
是流畅的选项生成器。
低级 ZhiPuAiApi 客户端
ZhiPuAiApi 为 ZhiPu AI API 提供的轻量级 Java 客户端。
以下是如何以编程方式使用 API 的简单片段:
ZhiPuAiApi zhiPuAiApi =
new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));
ChatCompletionMessage chatCompletionMessage =
new ChatCompletionMessage("Hello world", Role.USER);
// Sync request
ResponseEntity<ChatCompletion> response = this.zhiPuAiApi.chatCompletionEntity(
new ChatCompletionRequest(List.of(this.chatCompletionMessage), ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue(), 0.7, false));
// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.zhiPuAiApi.chatCompletionStream(
new ChatCompletionRequest(List.of(this.chatCompletionMessage), ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue(), 0.7, true));
请关注ZhiPuAiApi.java的 JavaDoc 以获取更多信息。
ZhiPuAiApi 示例
-
ZhiPuAiApiIT.java测试提供了一些如何使用轻量级库的一般示例。