QianFan Chat

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

先决条件

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

在 QianFan 注册页面 创建一个帐户，并在 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 为 Azure QianFan 嵌入客户端提供 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 嵌入客户端的重试机制。

属性 描述 默认值

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

aip.baidubce.com/rpc/2.0/ai_custom

spring.ai.qianfan.api-key

API 密钥

-

spring.ai.qianfan.secret-key

密钥

-

配置属性

前缀 spring.ai.qianfan.embedding 是配置 QianFan 的 EmbeddingClient 实现的属性前缀。

属性 描述 默认值

spring.ai.qianfan.embedding.enabled

启用 QianFan 嵌入客户端。

true

spring.ai.qianfan.embedding.base-url

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

-

spring.ai.qianfan.embedding.api-key

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

-

spring.ai.qianfan.embedding.secret-key

可选地覆盖 spring.ai.qianfan.secret-key 以提供特定于嵌入的密钥

-

spring.ai.qianfan.embedding.options.model

要使用的模型

bge_large_zh
您可以覆盖 ChatModel 和 EmbeddingModel 实现的通用 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 属性，则优先于通用属性。类似地，如果设置了 spring.ai.qianfan.chat.base-url、spring.ai.qianfan.chat.api-key 和 spring.ai.qianfan.chat.secret-key 属性，则优先于通用属性。如果您想对不同的模型和不同的模型端点使用不同的 QianFan 帐户，这很有用。
所有以 spring.ai.qianfan.embedding.options 为前缀的属性都可以在运行时通过向 EmbeddingRequest 调用添加特定于请求的 运行时选项 来覆盖。

运行时选项

QianFanEmbeddingOptions.java 提供了 QianFan 配置，例如要使用的模型等。

默认选项也可以使用spring.ai.qianfan.embedding.options属性进行配置。

在启动时，使用QianFanEmbeddingModel构造函数设置所有嵌入请求使用的默认选项。在运行时，您可以使用EmbeddingRequest的一部分QianFanEmbeddingOptions实例覆盖默认选项。

例如，要覆盖特定请求的默认模型名称

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        QianFanEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器

这将创建一个EmbeddingClient实现，您可以将其注入到您的类中。这是一个使用EmbeddingClient实现的简单@Controller类的示例。

spring.ai.qianfan.api-key=YOUR_API_KEY
spring.ai.qianfan.secret-key=YOUR_SECRET_KEY
spring.ai.qianfan.embedding.options.model=tao_8k
@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您没有使用 Spring Boot，则可以手动配置 QianFan Embedding Client。为此，请将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 添加到您的构建文件中。
spring-ai-qianfan依赖项还提供对QianFanChatModel的访问。有关QianFanChatModel的更多信息，请参阅QianFan Chat Client部分。

接下来，创建一个QianFanEmbeddingModel实例并使用它来计算两个输入文本之间的相似度

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

var embeddingClient = new QianFanEmbeddingModel(qianFanApi)
    .withDefaultOptions(QianFanChatOptions.build()
        .withModel("bge_large_en")
        .build());

EmbeddingResponse embeddingResponse = this.embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

QianFanEmbeddingOptions提供嵌入请求的配置信息。选项类提供了一个builder()用于轻松创建选项。