|
最新快照版本请使用Spring AI 1.1.0！ |
ZhiPu AI 聊天
Spring AI 支持 ZhiPu AI 的各种 AI 语言模型。你可以与ZhiPu AI语言模型交互，基于ZhiPuAI模型创建多语言对话助手。
前提条件
你需要用 ZhiPuAI 创建一个 API 来访问 ZhiPu 的 AI 语言模型。
在ZhiPu AI注册页面创建账户，并在API密钥页面生成Tokens。
Spring AI 项目定义了一个配置属性，名为Spring.ai.zhipuai.api-key。你应该设置为API 密钥获取自 API 密钥页面。
你可以在你的application.properties文件：
spring.ai.zhipuai.api-key=<your-zhipuai-api-key>为了在处理敏感信息如 API 密钥时增强安全性，您可以使用 Spring 表达式语言（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");自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 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作为属性前缀，用于配置ZhiPu AI聊天模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
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 |
连接性质
前缀春.ai.志蒲作为属性前缀，允许你连接到ZhiPuAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
Spring.ai.zhipuai.base-url |
连接的URL（链接） |
|
Spring.ai.zhipuai.api-key。 |
API 密钥 |
- |
配置属性
|
现在，启用和禁用聊天自动配置通过带有前缀的顶层属性进行配置 启用时，spring.ai.model.chat=zhipuai（默认启用） 要禁用，可以选择 spring.ai.model.chat=none（或任何与 zhipuai 不匹配的值） 此改动旨在允许配置多个模型。 |
前缀春.ai.zhipuai.chat是属性前缀，允许你配置ZhiPuAI的聊天模型实现。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.zhipuai.chat.enabled（已移除且不再有效） |
启用ZhiPuAI聊天模型。 |
true |
spring.ai.model.chat |
启用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聊天的模型 |
|
spring.ai.zhipuai.chat.options.maxTokens |
聊天补全时最多可生成的Tokens数。输入标记和生成标记的总长度受模型上下文长度限制。 |
- |
春.爱.志卜爱.聊天.选项.温度 |
采样温度应该在0到1之间。像0.8这样的高值会让输出更随机，而像0.2这样的低值则会让输出更聚焦和确定性强。我们通常建议修改这个或top_p，但不要两者兼用。 |
0.7 |
spring.ai.zhipuai.chat.options.topP |
一种与温度抽样不同的替代方案，称为核抽样，模型考虑以top_p概率质量计算的符号结果。因此，0.1 意味着只考虑构成概率质量最高 10% 的Tokens。我们一般建议调整温度，但不要两者兼备...... |
1.0 |
春.爱.聊天.options.停止 |
该模型将停止生成由停止字符指定的字符，目前仅支持格式为[“stop_word1”]的单个停止字。 |
- |
spring.ai.zhipuai.chat.options.user |
一个代表终端用户的唯一标识符，有助于ZhiPuAI监控和检测滥用行为。 |
- |
spring.ai.zhipuai.chat.options.requestId |
参数由客户端传递，必须确保唯一性。它用于区分每个请求的唯一标识符。如果客户端不提供，平台会默认生成。 |
- |
spring.ai.zhipuai.chat.options.do示例 |
当do_sample设置为true时，采样策略被启用。如果do_sample为假，采样策略参数温度和top_p将不生效。 |
true |
spring.ai.zhipuai.chat.options.proxy-tool-calls |
如果属实，Spring AI不会在内部处理函数调用，而是会代理给客户端。那么，客户端负责处理函数调用，将其派遣到相应的函数，并返回结果。如果 false（默认），Spring AI 会在内部处理函数调用。仅适用于支持函数调用的聊天模型 |
false |
你可以覆盖公共信息Spring.ai.zhipuai.base-url和Spring.ai.zhipuai.api-key。对于聊天模型实现。
这spring.ai.zhipuai.chat.base-url和spring.ai.zhipuai.chat.api-key。如果设置了属性，属性优先于常见属性。
如果你想为不同模型和不同模型端点使用不同的ZhiPuAI账户，这非常有用。 |
运行时选项
ZhiPuAiChatOptions.java提供模型配置，如使用模型、温度、频率惩罚等。
启动时，默认选项可以配置为ZhiPuAiChatModel（api，options）构造者或spring.ai.zhipuai.chat.options.*性能。
运行时，你可以通过添加新的、请求专属的选项来覆盖默认选项，提示叫。
例如，针对特定请求覆盖默认型号和温度：
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实例。 |
采样控制器
创建一个新的 Spring Boot 项目并添加春艾入门模型志普艾对你的POM（或Gradle）依赖。
添加一个application.properties文件，在src/主/资源目录，用于启用和配置ZhiPuAi聊天模型：
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密钥凭你的ZhiPuAI资质。 |
这将产生ZhPuAiChat模型你可以把这些实现注入到你的类里。
这里有一个简单的例子@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 实现了聊天模型和StreamingChatModel并使用低级的ZhiPuAiApi客户端连接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模型并用于文本生成：
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.Builder是流利期权构建器。
低级ZhiPuAiApi客户端
ZhiPuAiApi 提供了一个轻量级的 Java 客户端，支持 ZhiPu AI API。
这里有一个简单的示例，说明如何程序化使用该 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测试提供了一些使用轻量级库的通用示例。