Spring AI 整合聊天模型之智谱AI

Spring AI 支持智谱 AI（ZhiPu AI）的各种人工智能语言模型。可以与智谱 AI 的语言模型进行交互，并基于智谱 AI 的模型创建一个多语言会话助手。

前置作业

在智谱的官方站点： https://open.bigmodel.cn/ 注册并获取一个API Key。

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}

这个变量可以同环境变量设置，比如Linux 设置：

# 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");

自动配置

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

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

聊天属性（Chat Properties）

重试属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，用于为智谱 AI（ZhiPu AI）聊天模型配置重试机制。

连接属性（Connection Properties）

前缀 spring.ai.zhiPu 用作属性前缀，可用于连接到智谱 AI（ZhiPuAI）

配置属性（Configuration Properties）

聊天自动配置的启用和禁用现在可通过带有前缀 spring.ai.model.chat 的顶级属性进行配置。

若要启用，设置 spring.ai.model.chat=zhipuai（默认情况下已启用）

若要禁用，设置 spring.ai.model.chat=none（或设置为任何不匹配 zhipuai 的值）

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

可以为 ChatModel 实现覆盖通用的 spring.ai.zhipuai.base-url 和 spring.ai.zhipuai.api-key。如果设置了 spring.ai.zhipuai.chat.base-url 和 spring.ai.zhipuai.chat.api-key 属性，它们将优先于通用属性。当希望为不同的模型使用不同的智谱 AI（ZhiPuAI）账户以及不同的模型端点时，这一功能非常有用。

所有以 spring.ai.zhipuai.chat.options` 为前缀的属性，都可以在运行时通过向提示调用（Prompt call）中添加特定于请求的运行时选项（Runtime Options）来进行覆盖。

运行时选项（Runtime Options）

ZhiPuAiChatOptions.java 类提供了模型配置，例如要使用的模型、温度（temperature）、频率惩罚（frequency penalty）等。

在启动时，可以使用 ZhiPuAiChatModel(api, options) 构造函数或 spring.ai.zhipuai.chat.options.*` 属性来配置默认选项。

在运行时，您可以通过向提示调用（Prompt call）中添加新的、特定于请求的选项来覆盖默认选项。例如，要为特定请求覆盖默认模型和温度，可以这样做：

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 实例，该实例可以通过 ChatOptionsBuilder#builder() 方法来创建。

控制器的示例（Sample Controller）

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

在 src/main/resources 目录下添加一个 application.properties` 文件，以启用并配置智谱 AI（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

这将创建一个 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("/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);
    }
}

手动配置（Manual Configuration）

ZhiPuAiChatModel 实现了 ChatModel 和 StreamingChatModel 接口，并使用低级别的 `ZhiPuAiApi 客户端来连接到智谱 AI（ZhiPuAI）服务。

将 spring-ai-zhipuai 依赖项添加到项目的 Maven pom.xml` 文件中：

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

接下来，创建一个 ZhiPuAiChatModel` 实例，并使用它进行文本生成：

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 为聊天请求提供了配置信息。ZhiPuAiChatOptions.Builder 是一个流畅的选项构建器（fluent options builder）。

低层级智谱 AI（ZhiPuAi）API 客户端

ZhiPuAiApi` 提供了一个轻量级的 Java 客户端，用于访问智谱 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));