乾帆对话

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

先决条件

您需要创建一个乾帆 API 来访问乾帆语言模型。

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

export SPRING_AI_QIANFAN_API_KEY=<INSERT API KEY HERE>
export SPRING_AI_QIANFAN_SECRET_KEY=<INSERT SECRET KEY HERE>

添加仓库和 BOM

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

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

自动配置

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

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

或您的 Gradle build.gradle 构建文件。

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

聊天属性

重试属性

前缀spring.ai.retry 用作属性前缀，允许您配置乾帆聊天客户端的重试机制。

属性 描述 默认值

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.qianfan 用作属性前缀，允许您连接到乾帆。

属性 描述 默认值

spring.ai.qianfan.base-url

连接的 URL

api.qianfan.chat

spring.ai.qianfan.api-key

API 密钥

-

spring.ai.qianfan.secret-key

密钥

-

配置属性

前缀spring.ai.qianfan.chat 是属性前缀，允许您配置乾帆的聊天客户端实现。

属性 描述 默认值

spring.ai.qianfan.chat.enabled

启用乾帆聊天客户端。

true

spring.ai.qianfan.chat.base-url

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

api.qianfan.chat

spring.ai.qianfan.chat.api-key

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

-

spring.ai.qianfan.chat.secret-key

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

-

spring.ai.qianfan.chat.options.model

这是要使用的乾帆聊天模型

abab5.5-chat（abab5.5s-chat、abab5.5-chat 和 abab6-chat 指向最新的模型版本）

spring.ai.qianfan.chat.options.maxTokens

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

-

spring.ai.qianfan.chat.options.temperature

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

0.7

spring.ai.qianfan.chat.options.topP

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

1.0

spring.ai.qianfan.chat.options.presencePenalty

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

0.0f

spring.ai.qianfan.chat.options.frequencyPenalty

介于 -2.0 和 2.0 之间的数字。正值会根据新词元在当前文本中的现有频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。

0.0f

spring.ai.qianfan.chat.options.stop

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

-
您可以覆盖 ChatClient 实现的常用 spring.ai.qianfan.base-url、spring.ai.qianfan.api-key 和 spring.ai.qianfan.secret-key。如果设置了 spring.ai.qianfan.chat.base-url、spring.ai.qianfan.chat.api-key 和 spring.ai.qianfan.chat.secret-key 属性，则它们优先于常用属性。如果您想对不同的模型和不同的模型端点使用不同的 QianFan 帐户，这将非常有用。
所有以 spring.ai.qianfan.chat.options 为前缀的属性都可以在运行时通过向 Prompt 调用添加特定于请求的 运行时选项 来覆盖。

运行时选项

该 QianFanChatOptions.java 提供模型配置，例如要使用的模型、温度、频率惩罚等。

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

在运行时，您可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。例如，要覆盖特定请求的默认模型和温度。

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

示例控制器

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

在 src/main/resources 目录下添加一个 application.properties 文件，以启用和配置 QianFan Chat 客户端。

spring.ai.qianfan.api-key=YOUR_API_KEY
spring.ai.qianfan.secret-key=YOUR_SECRET_KEY
spring.ai.qianfan.chat.options.model=ernie_speed
spring.ai.qianfan.chat.options.temperature=0.7
将 api-key 和 secret-key 替换为您的 QianFan 凭据。

这将创建一个 QianFanChatModel 实现，您可以将其注入到您的类中。这是一个使用聊天客户端进行文本生成的简单 @Controller 类的示例。

@RestController
public class ChatController {

    private final QianFanChatModel chatClient;

    @Autowired
    public ChatController(QianFanChatModel chatClient) {
        this.chatClient = chatClient;
    }

    @GetMapping("/ai/generate")
    public Map generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("generation", this.chatClient.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.chatClient.stream(prompt);
    }
}

手动配置

该 QianFanChatModel 实现 ChatClient 和 StreamingChatClient，并使用 低级 QianFanApi 客户端 连接到 QianFan 服务。

将 spring-ai-qianfan 依赖项添加到您项目的 Maven pom.xml 文件中。

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

或您的 Gradle build.gradle 构建文件。

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

接下来，创建一个 QianFanChatModel 并将其用于文本生成。

var qianFanApi = new QianFanApi(System.getenv("QIANFAN_API_KEY"), System.getenv("QIANFAN_SECRET_KEY"));

var chatClient = new QianFanChatModel(this.qianFanApi, QianFanChatOptions.builder()
                .withModel(QianFanApi.ChatModel.ERNIE_Speed_8K.getValue())
                .withTemperature(0.4)
                .withMaxTokens(200)
                .build());

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

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

QianFanChatOptions 提供聊天请求的配置信息。QianFanChatOptions.Builder 是流畅的选项构建器。

低级 QianFanApi 客户端

该 QianFanApi 提供的是轻量级的 Java 客户端，用于 QianFan API。

这是一个关于如何以编程方式使用该 API 的简单代码片段。

String systemMessage = "Your name is QianWen";

QianFanApi qianFanApi =
    new QianFanApi(System.getenv("QIANFAN_API_KEY"), System.getenv("QIANFAN_SECRET_KEY"));

ChatCompletionMessage chatCompletionMessage =
    new ChatCompletionMessage("Hello world", Role.USER);

// Sync request
ResponseEntity<ChatCompletion> response = this.qianFanApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(this.chatCompletionMessage), this.systemMessage, QianFanApi.ChatModel.ERNIE_Speed_8K.getValue(), 0.7, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.qianFanApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(this.chatCompletionMessage), this.systemMessage, QianFanApi.ChatModel.ERNIE_Speed_8K.getValue(), 0.7, true));

请遵循 QianFanApi.java 的 JavaDoc 以获取更多信息。

QianFanApi 示例

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