智谱 AI Chat

Deepseek 3.2 中英对照 ZhiPu AI ZhiPu AI Chat

Spring AI 支持来自智谱 AI 的各种人工智能语言模型。你可以与智谱 AI 的语言模型进行交互，并基于智谱 AI 模型创建多语言对话助手。

如果您不是中文使用者，可以访问智谱AI的国际网站 Z.ai

前提条件

你需要创建一个API来接入智谱AI的语言模型。

在 智谱AI注册页面（或 Z.ai注册页面）创建账号，并在 API Keys页面（或 Z.ai API Keys页面）生成令牌。

Spring AI 项目定义了一个名为 spring.ai.zhipuai.api-key 的配置属性，你应该将其设置为从 API Keys 页面获取的 API Key 值。

您可以在 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");

添加仓库和 BOM

Spring AI 构件已发布至 Maven Central 和 Spring Snapshot 仓库。请参考构件仓库章节，将这些仓库添加至您的构建系统。

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

自动配置

备注

Spring AI 的自动配置和 starter 模块的工件名称已发生重大变化。更多信息请参阅 升级说明。

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-zhipuai'
}

:::提示
请参考 依赖管理 章节，将 Spring AI BOM 添加到你的构建文件中。
:::

聊天属性

重试属性

前缀 spring.ai.retry 用作属性前缀，允许您为 ZhiPu 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）。	empty
spring.ai.retry.on-http-codes	应触发重试的 HTTP 状态码列表（例如，用于抛出 TransientAiException）。	empty

连接属性

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

属性	描述	默认值
spring.ai.zhipuai.base-url	连接 ZhiPuAI API 的 URL。 如果您使用的是 Z.ai 平台，需要将其设置为 [https://api.z.ai/api/paas](https://api.z.ai/api/paas)。	[https://open.bigmodel.cn/api/paas](https://open.bigmodel.cn/api/paas)
spring.ai.zhipuai.api-key	API 密钥	-

配置属性

:::注意
聊天自动配置的启用和禁用现在通过顶级属性进行配置，属性前缀为 spring.ai.model.chat。

启用方式：spring.ai.model.chat=zhipuai （默认已启用）

禁用方式：spring.ai.model.chat=none （或任何不匹配 zhipuai 的值）

此项变更是为了支持配置多个模型。
:::

前缀 spring.ai.zhipuai.chat 是用于配置智谱 AI 聊天模型实现的属性前缀。

属性	描述	默认值
spring.ai.zhipuai.chat.enabled (已移除且不再有效)	启用智谱 AI 聊天模型。	true
spring.ai.model.chat	启用智谱 AI 聊天模型。	zhipuai
spring.ai.zhipuai.chat.base-url	可选，覆盖 spring.ai.zhipuai.base-url 以提供聊天特定的 URL。 如果使用 Z.ai 平台，需要将其设置为 [https://api.z.ai/api/paas](https://api.z.ai/api/paas)。	[https://open.bigmodel.cn/api/paas](https://open.bigmodel.cn/api/paas)
spring.ai.zhipuai.chat.api-key	可选，覆盖 spring.ai.zhipuai.api-key 以提供聊天特定的 API 密钥。	-
spring.ai.zhipuai.chat.options.model	这是要使用的智谱 AI 聊天模型。可以在诸如 glm-4.6、glm-4.5、glm-4-air 等模型之间选择。	glm-4-air
spring.ai.zhipuai.chat.options.maxTokens	聊天补全中生成的最大令牌数。输入令牌和生成令牌的总长度受模型上下文长度的限制。	-
spring.ai.zhipuai.chat.options.temperature	使用的采样温度，介于 0 和 1 之间。较高的值（如 0.8）会使输出更加随机，而较低的值（如 0.2）会使其更加集中和确定。通常建议调整此参数或 top_p，但不要同时调整两者。	0.7
spring.ai.zhipuai.chat.options.topP	温度采样的替代方法，称为核采样，模型考虑具有 top_p 概率质量的令牌结果。因此，0.1 意味着只考虑构成前 10% 概率质量的令牌。通常建议调整此参数或 temperature，但不要同时调整两者。	1.0
spring.ai.zhipuai.chat.options.stop	模型将停止生成由 stop 指定的字符，目前仅支持单个停止词，格式为 ["stop_word1"]	-
spring.ai.zhipuai.chat.options.user	代表终端用户的唯一标识符，可以帮助智谱 AI 监控和检测滥用行为。	-
spring.ai.zhipuai.chat.options.requestId	此参数由客户端传递，必须确保唯一性。用于区分每个请求的唯一标识符。如果客户端未提供，平台将默认生成。	-
spring.ai.zhipuai.chat.options.doSample	当 do_sample 设置为 true 时，启用采样策略。如果 do_sample 为 false，则采样策略参数 temperature 和 top_p 不会生效。	true
spring.ai.zhipuai.chat.options.response-format.type	控制模型输出的格式。设置为 json_object 以确保消息是有效的 JSON 对象。可用选项：text 或 json_object。	-
spring.ai.zhipuai.chat.options.thinking.type	控制是否启用大模型的思维链。可用选项：enabled 或 disabled。	-
spring.ai.zhipuai.chat.options.tool-names	工具名称列表，用于在单个提示请求中启用函数调用。具有这些名称的工具必须存在于 ToolCallback 注册表中。	-
spring.ai.zhipuai.chat.options.tool-callbacks	要注册到 ChatModel 的工具回调。	-
spring.ai.zhipuai.chat.options.internal-tool-execution-enabled	如果为 false，Spring AI 将不会在内部处理工具调用，而是将其代理给客户端。然后由客户端负责处理工具调用，将其分派给适当的函数，并返回结果。如果为 true（默认），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型。	true

备注

你可以为 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()
            .model(ZhiPuAiApi.ChatModel.GLM_4_Air.getValue())
            .temperature(0.5)
        .build()
    ));

提示

除了模型特定的 ZhiPuAiChatOptions 之外，你也可以使用一个可移植的 ChatOptions 实例，该实例可以通过 ChatOptions#builder() 创建。

示例控制器

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

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

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 替换为您的智谱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", 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>

或添加到您的 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(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 提供了聊天请求的配置信息。ZhiPuAiChatOptions.Builder 是流畅的选项构建器。

低级 ZhiPuAiApi 客户端

ZhiPuAiApi 为 智谱 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_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。

ZhiPuAiApi 示例

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