智谱 AI 聊天

Spring AI 支持智谱 AI 的各种 AI 语言模型。您可以与智谱 AI 语言模型交互，并基于智谱 AI 模型创建多语言对话式助手。

先决条件

您需要创建一个与智谱AI的API，才能访问智谱AI语言模型。

在 智谱AI注册页面 创建一个帐户，并在 API Keys 页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.zhipuai.api-key 的配置属性，您应该将其设置为从 API Keys 页面 获取的 API Key 的值。导出环境变量是设置该配置属性的一种方法。

export SPRING_AI_ZHIPU_AI_API_KEY=<INSERT KEY HERE>

添加仓库和BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 仓库中。请参考 仓库 部分，将这些仓库添加到您的构建系统中。

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

自动配置

Spring AI 为智谱AI聊天客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您的项目的 Maven pom.xml 文件中

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

或添加到您的 Gradle build.gradle 构建文件中。

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

聊天属性

重试属性

前缀 spring.ai.retry 用作属性前缀，允许您配置智谱AI聊天模型的重试机制。

属性 描述 默认值

spring.ai.retry.max-attempts

最大重试次数。

10

spring.ai.retry.backoff.initial-interval

指数退避策略的初始休眠时长。

2 秒。

spring.ai.retry.backoff.multiplier

退避间隔乘数。

5

spring.ai.retry.backoff.max-interval

最大退避时长。

3 分钟。

spring.ai.retry.on-client-errors

如果为 false，则抛出 NonTransientAiException，并且不会尝试对 4xx 客户端错误代码进行重试。

false

spring.ai.retry.exclude-on-http-codes

不应触发重试的 HTTP 状态码列表（例如，抛出 NonTransientAiException）。

空

spring.ai.retry.on-http-codes

应触发重试的 HTTP 状态码列表（例如，抛出 TransientAiException）。

空

连接属性

前缀 spring.ai.zhiPu 用作属性前缀，允许您连接到 ZhiPuAI。

属性 描述 默认值

spring.ai.zhipuai.base-url

连接到的 URL

open.bigmodel.cn/api/paas

spring.ai.zhipuai.api-key

API 密钥

-

配置属性

前缀 spring.ai.zhipuai.chat 是属性前缀，允许您配置 ZhiPuAI 的聊天模型实现。

属性 描述 默认值

spring.ai.zhipuai.chat.enabled

启用 ZhiPuAI 聊天模型。

true

spring.ai.zhipuai.chat.base-url

可选地覆盖 spring.ai.zhipuai.base-url 以提供特定于聊天的 URL

open.bigmodel.cn/api/paas

spring.ai.zhipuai.chat.api-key

可选地覆盖 spring.ai.zhipuai.api-key 以提供特定于聊天的 api-key

-

spring.ai.zhipuai.chat.options.model

这是要使用的 ZhiPuAI 聊天模型

GLM-3-Turbo (GLM-3-Turbo、GLM-4 和 GLM-4V 指向最新的模型版本)

spring.ai.zhipuai.chat.options.maxTokens

在聊天完成中生成的令牌的最大数量。输入令牌和生成的令牌的总长度受模型上下文长度的限制。

-

spring.ai.zhipuai.chat.options.temperature

要使用的采样温度，它控制生成的完成的明显创造性。较高的值将使输出更加随机，而较低的值将使结果更加集中和确定性。不建议为同一个完成请求修改温度和 top_p，因为这两个设置的交互难以预测。

0.7

spring.ai.zhipuai.chat.options.topP

使用温度进行采样的另一种方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。因此，0.1 表示仅考虑包含前 10% 概率质量的令牌。我们通常建议更改此值或温度，但不要同时更改两者。

1.0

spring.ai.zhipuai.chat.options.n

为每个输入消息生成多少个聊天完成选项。请注意，您将根据所有选项中生成的令牌数量付费。默认值为 1，不能大于 5。具体来说，当温度非常小且接近 0 时，我们只能返回 1 个结果。如果此时 n 已经设置并且>1，服务将返回一个非法的输入参数（invalid_request_error）

1

spring.ai.zhipuai.chat.options.presencePenalty

-2.0 到 2.0 之间的数字。正值根据新令牌是否出现在到目前为止的文本中来惩罚新令牌，从而增加模型谈论新主题的可能性。

0.0f

spring.ai.zhipuai.chat.options.frequencyPenalty

-2.0 到 2.0 之间的数字。正值会根据新词在文本中出现的频率对它们进行惩罚，从而降低模型重复相同行的可能性。

0.0f

spring.ai.zhipuai.chat.options.stop

模型将停止生成由 stop 指定的字符，目前仅支持 ["stop_word1"] 格式的单个停止词。

-

spring.ai.zhipuai.chat.options.user

一个代表您的最终用户的唯一标识符，可以帮助智谱 AI 监控和检测滥用行为。

-
您可以覆盖 ChatModel 实现的通用 spring.ai.zhipuai.base-url 和 spring.ai.zhipuai.api-key。如果设置了 spring.ai.zhipuai.chat.base-url 和 spring.ai.zhipuai.chat.api-key 属性，则优先于通用属性。如果您想对不同的模型和不同的模型端点使用不同的智谱 AI 帐户，这将很有用。
所有以 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()
            .withModel(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
            .withTemperature(0.5f)
        .build()
    ));
除了特定于模型的 ZhiPuAiChatOptions 之外，您还可以使用可移植的 ChatOptions 实例，该实例使用 ChatOptionsBuilder#builder() 创建。

示例控制器

创建 一个新的 Spring Boot 项目，并将 spring-ai-zhipuai-spring-boot-starter 添加到您的 pom（或 gradle）依赖项中。

在 src/main/resources 目录下添加一个 application.properties 文件，以启用和配置智谱 AI 聊天模型

spring.ai.zhipuai.api-key=YOUR_API_KEY
spring.ai.zhipuai.chat.options.model=glm-3-turbo
spring.ai.zhipuai.chat.options.temperature=0.7
将 api-key 替换为您的智谱 AI 凭据。

这将创建一个 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", 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 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>

或添加到您的 Gradle build.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(zhiPuAiApi, ZhiPuAiChatOptions.builder()
                .withModel(ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue())
                .withTemperature(0.4f)
                .withMaxTokens(200)
                .build());

ChatResponse response = chatModel.call(
    new Prompt("Generate the names of 5 famous pirates."));

// Or with streaming responses
Flux<ChatResponse> streamResponse = chatModel.stream(
    new Prompt("Generate the names of 5 famous pirates."));

ZhiPuAiChatOptions 提供聊天请求的配置信息。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 = zhiPuAiApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(chatCompletionMessage), ZhiPuAiApi.ChatModel.GLM_3_Turbo.getValue(), 0.7f, false));

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

有关更多信息，请参阅 ZhiPuAiApi.java 的 JavaDoc。

ZhiPuAiApi 示例

  • 该 ZhiPuAiApiIT.java 测试提供了一些关于如何使用轻量级库的一般示例。