此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT!spring-doc.cn

千帆聊天

Spring AI 支持 QianFan 的各种 AI 语言模型。您可以与 QianFan 语言模型交互,并基于 QianFan 模型创建多语言对话助手。spring-doc.cn

先决条件

您需要使用 QianFan 创建一个 API 才能访问 QianFan 语言模型。spring-doc.cn

QianFan 注册页面创建账号,并在 API Keys 页面生成 Token。 Spring AI 项目定义了一个名为 和 的配置属性。 您应该设置为 和 从 API 密钥页面获取的值。 导出环境变量是设置该配置属性的一种方法:spring.ai.qianfan.api-keyspring.ai.qianfan.secret-keyAPI KeySecret Keyspring-doc.cn

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 存储库中。 请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。spring-doc.cn

为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。spring-doc.cn

自动配置

Spring AI 为 Azure QianFan Embedding Client 提供了 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Maven 文件中:pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-qianfan-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

重试属性

前缀用作属性前缀,允许您为 QianFan Embedding 客户端配置重试机制。spring.ai.retryspring-doc.cn

财产 描述 违约

spring.ai.retry.max 次尝试spring-doc.cn

最大重试尝试次数。spring-doc.cn

10spring-doc.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cn

指数回退策略的初始休眠持续时间。spring-doc.cn

2 秒spring-doc.cn

spring.ai.retry.backoff.multiplierspring-doc.cn

Backoff interval 乘数。spring-doc.cn

5spring-doc.cn

spring.ai.retry.backoff.max 间隔spring-doc.cn

最大回退持续时间。spring-doc.cn

3 分钟spring-doc.cn

spring.ai.retry.on-client-errorsspring-doc.cn

如果为 false,则引发 NonTransientAiException,并且不要尝试重试客户端错误代码4xxspring-doc.cn

spring-doc.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cn

不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。spring-doc.cn

spring-doc.cn

spring.ai.retry.on-http-codesspring-doc.cn

应触发重试的 HTTP 状态代码列表(例如,引发 TransientAiException)。spring-doc.cn

spring-doc.cn

连接属性

前缀用作用于连接到 QianFan 的属性前缀。spring.ai.qianfanspring-doc.cn

财产 描述 违约

spring.ai.qianfan.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

aip.baidubce.com/rpc/2.0/ai_customspring-doc.cn

spring.ai.qianfan.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.qianfan.secret-keyspring-doc.cn

密钥spring-doc.cn

-spring-doc.cn

配置属性

prefix 是 property prefix,用于配置 QianFan 的实现。spring.ai.qianfan.embeddingEmbeddingClientspring-doc.cn

财产 描述 违约

spring.ai.qianfan.embedding.enabledspring-doc.cn

启用 QianFan 嵌入客户端。spring-doc.cn

spring-doc.cn

spring.ai.qianfan.embedding.base-urlspring-doc.cn

Optional 覆盖 spring.ai.qianfan.base-url 以提供嵌入特定的 urlspring-doc.cn

-spring-doc.cn

spring.ai.qianfan.embedding.api-keyspring-doc.cn

Optional 覆盖 spring.ai.qianfan.api-key 以提供嵌入特定的 api-keyspring-doc.cn

-spring-doc.cn

spring.ai.qianfan.embedding.secret-keyspring-doc.cn

Optional 覆盖 spring.ai.qianfan.secret-key 以提供嵌入特定的 secret-keyspring-doc.cn

-spring-doc.cn

spring.ai.qianfan.embedding.options.modelspring-doc.cn

要使用的模型spring-doc.cn

bge_large_zhspring-doc.cn

您可以覆盖通用的 、 和 和 的实施。 的 和 properties (如果设置) 优先于公共属性。 同样,如果设置了 , 和 properties (如果设置),则优先于公共属性。 如果您想为不同的模型和不同的模型终端节点使用不同的 QianFan 帐户,这将非常有用。spring.ai.qianfan.base-urlspring.ai.qianfan.api-keyspring.ai.qianfan.secret-keyChatModelEmbeddingModelspring.ai.qianfan.chat.base-urlspring.ai.qianfan.chat.api-keyspring.ai.qianfan.chat.secret-keyspring.ai.qianfan.chat.base-urlspring.ai.qianfan.chat.api-keyspring.ai.qianfan.chat.secret-key
通过向调用添加特定于请求的运行时选项,可以在运行时覆盖所有前缀为 的属性。spring.ai.qianfan.embedding.optionsEmbeddingRequest

运行时选项

QianFanEmbeddingOptions.java 提供了 QianFan 的配置,例如要使用的模型等。spring-doc.cn

也可以使用 properties 配置默认选项。spring.ai.qianfan.embedding.optionsspring-doc.cn

在启动时,使用构造函数设置用于所有嵌入请求的默认选项。 在运行时,您可以覆盖默认选项,将实例用作 .QianFanEmbeddingModelQianFanEmbeddingOptionsEmbeddingRequestspring-doc.cn

例如,要覆盖特定请求的默认模型名称:spring-doc.cn

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()));

Samples控制器

这将创建一个可以注入到类中的实现。 下面是一个使用该实现的简单类的示例。EmbeddingClient@ControllerEmbeddingClientspring-doc.cn

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。 为此,请将依赖项添加到项目的 Maven 文件中:spring-ai-qianfanpom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-qianfan'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。
依赖项还提供对 . 有关更多信息,请参阅 QianFan Chat 客户端部分。spring-ai-qianfanQianFanChatModelQianFanChatModel

接下来,创建一个实例并使用它来计算两个输入文本之间的相似性:QianFanEmbeddingModelspring-doc.cn

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

这提供了嵌入请求的配置信息。 options 类提供了一个用于轻松创建选项的工具。QianFanEmbeddingOptionsbuilder()spring-doc.cn