QianFan Chat

Spring AI 支援來自 QianFan 的各種 AI 語言模型。您可以使用 QianFan 模型互動，並建立多語言對話助理。

先決條件

您需要使用 QianFan 建立 API，才能存取 QianFan 語言模型。

在 QianFan 註冊頁面 建立帳戶，並在 API 金鑰頁面 產生權杖。Spring AI 專案定義了名為 spring.ai.qianfan.api-key 和 spring.ai.qianfan.secret-key 的組態屬性。您應該將其設定為從 API 金鑰頁面 取得的 API 金鑰 和 Secret Key 值。匯出環境變數是設定該組態屬性的一種方式

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 為 QianFan Chat Client 提供 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 用作屬性前綴，讓您可以設定 QianFan Chat Client 的重試機制。

屬性 描述 預設值

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 用作屬性前綴，讓您可以連線到 QianFan。

屬性 描述 預設值

spring.ai.qianfan.base-url

要連線的 URL

api.qianfan.chat

spring.ai.qianfan.api-key

API 金鑰

-

spring.ai.qianfan.secret-key

Secret Key

-

組態屬性

前綴 spring.ai.qianfan.chat 是屬性前綴，讓您可以設定 QianFan 的聊天客戶端實作。

屬性 描述 預設值

spring.ai.qianfan.chat.enabled

啟用 QianFan 聊天客戶端。

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 金鑰

-

spring.ai.qianfan.chat.secret-key

可選覆寫 spring.ai.qianfan.secret-key 以提供聊天特定 Secret Key

-

spring.ai.qianfan.chat.options.model

這是要使用的 QianFan Chat 模型

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 Client

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 Client 連線到 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 Client

QianFanApi 為 QianFan API 提供了輕量級 Java 客戶端。

以下是關於如何以程式設計方式使用 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 測試提供了一些關於如何使用輕量級程式庫的一般範例。