ZhiPu AI 聊天

Spring AI 支持来自 ZhiPu AI 的各种 AI 语言模型。你可以与 ZhiPu AI 语言模型互动,基于 ZhiPuAI 模型创建多语言对话助手。spring-doc.cadn.net.cn

如果你不是中文母语者,可以访问志普艾国际网站 Z.aispring-doc.cadn.net.cn

前提条件

你需要用 ZhiPuAI 创建一个 API 来访问 ZhiPu 的 AI 语言模型。spring-doc.cadn.net.cn

Spring AI 项目定义了一个配置属性,名为Spring.ai.zhipuai.api-key。你应该设置为API 密钥获取自 API 密钥页面。spring-doc.cadn.net.cn

你可以在你的application.properties文件:spring-doc.cadn.net.cn

spring.ai.zhipuai.api-key=<your-zhipuai-api-key>

为了在处理敏感信息如 API 密钥时增强安全性,您可以使用 Spring 表达式语言(SpEL)引用自定义环境变量:spring-doc.cadn.net.cn

# 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>

你也可以在应用代码中编程设置此配置:spring-doc.cadn.net.cn

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("ZHIPUAI_API_KEY");

添加仓库和物料清单

Spring AI 产物发布于 Maven Central 和 Spring Snapshot 仓库中。 请参阅神器仓库部分,将这些仓库添加到你的构建系统中。spring-doc.cadn.net.cn

为帮助依赖管理,Spring AI 提供了物料清单(BOM),确保整个项目中使用一致版本的 Spring AI。请参考依赖管理部分,将春季AI物料清单添加到你的构建系统中。spring-doc.cadn.net.cn

自动配置

春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明spring-doc.cadn.net.cn

Spring AI 为 ZhiPuAI 聊天客户端提供 Spring Boot 自动配置。要启用它,请在你的项目 Maven 中添加以下依赖pom.xml文件:spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-zhipuai</artifactId>
</dependency>

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。

聊天属性

重试属性

前缀spring.ai.retry作为属性前缀,用于配置ZhiPu AI聊天模型的重试机制。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.retry.max尝试spring-doc.cadn.net.cn

重试次数上限。spring-doc.cadn.net.cn

10spring-doc.cadn.net.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cadn.net.cn

指数式退避政策的初始睡眠时长。spring-doc.cadn.net.cn

两秒钟。spring-doc.cadn.net.cn

spring.ai.retry.backoff.multiplierspring-doc.cadn.net.cn

后退间隔倍数。spring-doc.cadn.net.cn

5spring-doc.cadn.net.cn

spring.ai.retry.backoff.max区间spring-doc.cadn.net.cn

最大退回时间。spring-doc.cadn.net.cn

3分钟。spring-doc.cadn.net.cn

spring.ai.retry.on-client-errorsspring-doc.cadn.net.cn

如果为假,抛出非瞬态AiException,且不要尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cadn.net.cn

不应该触发重试的HTTP状态码列表(例如抛出非瞬态Ai异常)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

spring.ai.retry.on-http-codesspring-doc.cadn.net.cn

应触发重试的HTTP状态码列表(例如抛出TransientAiException)。spring-doc.cadn.net.cn

emptyspring-doc.cadn.net.cn

连接性质

前缀spring.ai.zhipuai作为属性前缀,允许你连接到ZhiPuAI。spring-doc.cadn.net.cn

属性 描述 默认值

Spring.ai.zhipuai.base-urlspring-doc.cadn.net.cn

连接ZhiPuAI API的URL。
如果你用的是 Z.ai 平台,需要设置为
https://api.z.ai/api/paas.spring-doc.cadn.net.cn

https://open.bigmodel.cn/api/paasspring-doc.cadn.net.cn

Spring.ai.zhipuai.api-key。spring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

配置属性

现在,启用和禁用聊天自动配置通过带有前缀的顶层属性进行配置spring.ai.model.chat.spring-doc.cadn.net.cn

启用时,spring.ai.model.chat=zhipuai(默认启用)spring-doc.cadn.net.cn

要禁用,可以选择 spring.ai.model.chat=none(或任何与 zhipuai 不匹配的值)spring-doc.cadn.net.cn

此改动旨在允许配置多个模型。spring-doc.cadn.net.cn

前缀春.ai.zhipuai.chat是属性前缀,允许你配置ZhiPuAI的聊天模型实现。spring-doc.cadn.net.cn

属性 描述 默认值

spring.ai.zhipuai.chat.enabled(已移除且不再有效)spring-doc.cadn.net.cn

启用ZhiPuAI聊天模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.chatspring-doc.cadn.net.cn

启用ZhiPuAI聊天模型。spring-doc.cadn.net.cn

志卜爱spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.base-urlspring-doc.cadn.net.cn

可选选项覆盖了 spring.ai.zhipuai.base-url,提供针对聊天的 URL。
如果你用的是 Z.ai 平台,你需要将其设置为
https://api.z.ai/api/paas.spring-doc.cadn.net.cn

https://open.bigmodel.cn/api/paasspring-doc.cadn.net.cn

spring.ai.zhipuai.chat.api-key。spring-doc.cadn.net.cn

可选覆盖 spring.ai.zhipuai.api-key,提供针对聊天的 api-key。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.modelspring-doc.cadn.net.cn

这就是ZhiPuAI聊天模型。你可以选择以下模型:GLM-4.6,GLM-4.5,GLM-4-Air,以及更多。spring-doc.cadn.net.cn

GLM-4-Airspring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.maxTokensspring-doc.cadn.net.cn

聊天补全时可生成的最大Tokens数。输入Tokens和生成Tokens的总长度受模型上下文长度限制。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

春.爱.志卜爱.聊天.选项.温度spring-doc.cadn.net.cn

采样温度应该在0到1之间。像0.8这样的取样温度越高,输出就越随机,而像0.2这样的低值则会让输出更聚焦、更有确定性。我们一般建议可以调整这个或top_p,但不要两者都做。spring-doc.cadn.net.cn

0.7spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.topPspring-doc.cadn.net.cn

一种与温度抽样不同的替代方案,称为核抽样,模型考虑以top_p概率质量计算的符号结果。因此,0.1 意味着只考虑构成概率质量最高 10% 的Tokens。我们一般建议调整温度,但不要两者兼备......spring-doc.cadn.net.cn

1.0spring-doc.cadn.net.cn

春.爱.聊天.options.停止spring-doc.cadn.net.cn

该模型将停止生成由停止字符指定的字符,目前仅支持格式为[“stop_word1”]的单个停止字。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.userspring-doc.cadn.net.cn

一个代表终端用户的唯一标识符,有助于ZhiPuAI监控和检测滥用行为。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.requestIdspring-doc.cadn.net.cn

参数由客户端传递,必须确保唯一性。它用于区分每个请求的唯一标识符。如果客户端不提供,平台会默认生成。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.do示例spring-doc.cadn.net.cn

当do_sample设置为true时,采样策略被启用。如果do_sample为假,采样策略参数温度和top_p将不生效。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.response-format.typespring-doc.cadn.net.cn

控制模型输出格式。设置为json_object以确保消息是有效的 JSON 对象。可选方案:文本json_object.spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.thinking.typespring-doc.cadn.net.cn

控制是否启用大型模型的思维链。可选方案:启用禁用.spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.tool-namesspring-doc.cadn.net.cn

列出了工具,按名称标识,用于在一次提示请求中实现函数调用。带有这些名称的工具必须存在于 ToolCallback 注册表中。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.tool-callbacksspring-doc.cadn.net.cn

工具回调以注册到聊天模型。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.internal-tool-execution-enabledspring-doc.cadn.net.cn

如果错误,Spring AI不会内部处理工具调用,而是代理给客户端。然后由客户端负责处理工具调用,将其派遣到相应函数,并返回结果。如果为真(默认),Spring AI会在内部处理函数调用。仅适用于支持函数调用的聊天模型spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

你可以覆盖公共信息Spring.ai.zhipuai.base-urlSpring.ai.zhipuai.api-key。对于聊天模型实现。 这spring.ai.zhipuai.chat.base-urlspring.ai.zhipuai.chat.api-key。如果设置了属性,属性优先于常见属性。 如果你想为不同模型和不同模型端点使用不同的ZhiPuAI账户,这非常有用。
所有以spring.ai.zhipuai.chat.options.options可以通过在运行时为 在提示叫。

运行时选项

ZhiPuAiChatOptions.java提供模型配置,如使用模型、温度、频率惩罚等。spring-doc.cadn.net.cn

启动时,默认选项可以配置为ZhiPuAiChatModel(api,options)构造者或spring.ai.zhipuai.chat.options.*性能。spring-doc.cadn.net.cn

运行时,你可以通过添加新的、请求专属的选项来覆盖默认选项,提示叫。 例如,针对特定请求覆盖默认型号和温度:spring-doc.cadn.net.cn

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        ZhiPuAiChatOptions.builder()
            .model(ZhiPuAiApi.ChatModel.GLM_4_Air.getValue())
            .temperature(0.5)
        .build()
    ));
除了模型特定的ZhiPuAiChatOptions,你还可以使用用ChatOptions#builder()创建的便携式ChatOptions实例。

采样控制器

创建一个新的 Spring Boot 项目并添加春艾入门模型志普艾对你的POM(或Gradle)依赖。spring-doc.cadn.net.cn

添加一个application.properties文件,在src/主/资源目录,用于启用和配置ZhiPuAi聊天模型:spring-doc.cadn.net.cn

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使用聊天模式生成文本的课程。spring-doc.cadn.net.cn

@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服务。spring-doc.cadn.net.cn

添加春艾志卜艾对你项目Maven的依赖pom.xml文件:spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-zhipuai</artifactId>
</dependency>

或者去你的Gradlebuild.gradle构建文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}
请参考依赖管理部分,将Spring AI的物料清单添加到你的构建文件中。

接下来,创建一个ZhPuAiChat模型并用于文本生成:spring-doc.cadn.net.cn

var zhiPuAiApi = new ZhiPuAiApi(System.getenv("ZHIPU_AI_API_KEY"));

var chatModel = new ZhiPuAiChatModel(this.zhiPuAiApi, ZhiPuAiChatOptions.builder()
                .model(ZhiPuAiApi.ChatModel.GLM_4_Air.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是流利期权构建器。spring-doc.cadn.net.cn

低级ZhiPuAiApi客户端

ZhiPuAiApi 提供了一个轻量级的 Java 客户端,支持 ZhiPu AI APIspring-doc.cadn.net.cn

这里有一个简单的示例,说明如何程序化使用该 API:spring-doc.cadn.net.cn

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_4_Air.getValue(), 0.7, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.zhiPuAiApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(this.chatCompletionMessage), ZhiPuAiApi.ChatModel.GLM_4_Air.getValue(), 0.7, true));

更多信息请关注ZhiPuAiApi.java的JavaDoc。spring-doc.cadn.net.cn

ZhiPuAiApi 样本