智普 AI 聊天

Spring AI 支持 ZhiPu AI 的各种 AI 语言模型。您可以与 ZhiPu AI 语言模型交互，并基于 ZhiPuAI 模型创建多语言对话助手。spring-doc.cadn.net.cn

先决条件

您需要使用 ZhiPuAI 创建 API 才能访问 ZhiPu AI 语言模型。spring-doc.cadn.net.cn

在 智普 AI 注册页面创建账号，并在 API Keys 页面生成 Token。 Spring AI 项目定义了一个名为spring.ai.zhipuai.api-key，您应该设置为API Key从 API 密钥页面获取。 导出环境变量是设置该配置属性的一种方法：spring-doc.cadn.net.cn

export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。 请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。spring-doc.cadn.net.cn

为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。spring-doc.cadn.net.cn

自动配置

Spring AI 为 ZhiPuAI Chat 客户端提供了 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml文件：spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

聊天属性

重试属性

前缀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

2 秒spring-doc.cadn.net.cn

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

Backoff interval 乘数。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

如果为 false，则抛出 NonTransientAiException，并且不要尝试重试4xx客户端错误代码spring-doc.cadn.net.cn

假spring-doc.cadn.net.cn

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

不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。spring-doc.cadn.net.cn

空spring-doc.cadn.net.cn

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

应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。spring-doc.cadn.net.cn

空spring-doc.cadn.net.cn

连接属性

前缀spring.ai.zhiPu用作用于连接到 ZhiPuAI 的属性前缀。spring-doc.cadn.net.cn

财产 描述 违约

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

要连接到的 URLspring-doc.cadn.net.cn

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

spring.ai.zhipuai.api-keyspring-doc.cadn.net.cn

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

-spring-doc.cadn.net.cn

配置属性

前缀spring.ai.zhipuai.chat是属性前缀，用于为 ZhiPuAI 配置聊天模型实现。spring-doc.cadn.net.cn

财产 描述 违约

spring.ai.zhipuai.chat.enabledspring-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以提供特定于聊天的 urlspring-doc.cadn.net.cn

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

spring.ai.zhipuai.chat.api-keyspring-doc.cadn.net.cn

可选覆盖 spring.ai.zhipuai.api-key 以提供特定于聊天的 api-keyspring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

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

这是要使用的 ZhiPuAI Chat 模型spring-doc.cadn.net.cn

GLM-3-Turbo（GLM-3-Turbo,GLM-4,GLM-4-Air,GLM-4-AirX,GLM-4-Flash和GLM-4V指向最新的模型版本）spring-doc.cadn.net.cn

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

在聊天完成中生成的最大令牌数。输入标记和生成的标记的总长度受模型的上下文长度限制。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.zhipuai.chat.options.temperaturespring-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% 概率质量的 token。我们通常建议改变这个或温度，但不能同时改变两者..spring-doc.cadn.net.cn

1.0spring-doc.cadn.net.cn

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

该模型将停止生成 stop 指定的字符，目前仅支持 [“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 为 false，则采样策略参数 temperature 和 top_p 不会生效。spring-doc.cadn.net.cn

真spring-doc.cadn.net.cn

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

如果为true，则 Spring AI 将不会在内部处理函数调用，而是将它们代理给客户端。然后，客户端负责处理函数调用，将它们分派给适当的函数，并返回结果。如果为 false （默认值），则 Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型spring-doc.cadn.net.cn

假spring-doc.cadn.net.cn
您可以覆盖常见的spring.ai.zhipuai.base-url和spring.ai.zhipuai.api-key对于ChatModel实现。 这spring.ai.zhipuai.chat.base-url和spring.ai.zhipuai.chat.api-key如果设置了 properties，则优先于 common properties。 如果您想为不同的模型和不同的模型终端节点使用不同的 ZhiPuAI 帐户，这将非常有用。
所有前缀为spring.ai.zhipuai.chat.options可以通过将特定于请求的运行时选项添加到Prompt叫。

运行时选项

ZhiPuAiChatOptions.java 提供模型配置，例如要使用的模型、温度、频率损失等。spring-doc.cadn.net.cn

启动时，可以使用ZhiPuAiChatModel(api, options)constructor 或spring.ai.zhipuai.chat.options.*性能。spring-doc.cadn.net.cn

在运行时，您可以通过向Prompt叫。 例如，要覆盖特定请求的默认模型和温度：spring-doc.cadn.net.cn

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        ZhiPuAiChatOptions.builder()
            .withModel(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
            .withTemperature(0.5)
        .build()
    ));
除了特定于模型的 ZhiPuAiChatOptions 之外，您还可以使用通过 ChatOptionsBuilder#builder（） 创建的可移植 ChatOptions 实例。

Samples控制器

创建一个新的 Spring Boot 项目并添加spring-ai-zhipuai-spring-boot-starter添加到您的 POM（或 Gradle）依赖项中。spring-doc.cadn.net.cn

添加application.properties文件中的src/main/resources目录下，开启和配置 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-key替换为您的 ZhiPuAI 凭据。

这将创建一个ZhiPuAiChatModel实现，您可以将其注入到您的类中。 下面是一个简单的示例@Controller使用 Chat 模型生成文本的类。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("/ai/generateStream")
	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 Client 连接 ZhiPuAI 服务。spring-doc.cadn.net.cn

添加spring-ai-zhipuai依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-zhipuai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个ZhiPuAiChatModel并将其用于文本生成：spring-doc.cadn.net.cn

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

var chatModel = new ZhiPuAiChatModel(this.zhiPuAiApi, ZhiPuAiChatOptions.builder()
                .withModel(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
                .withTemperature(0.4)
                .withMaxTokens(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是 Fluent Options Builder。spring-doc.cadn.net.cn

低级 ZhiPuAiApi 客户端

ZhiPuAiApi 提供的是 ZhiPu AI API 的轻量级 Java 客户端。spring-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_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。spring-doc.cadn.net.cn

ZhiPuAiApi 示例