千帆聊天
Spring AI 支持来自 QianFan 的各种 AI 语言模型。您可以与 QianFan 语言模型进行交互,并基于 QianFan 模型创建一个多语言对话助手。
先决条件
你需要创建一个 API 来访问 QianFan 语言模型。
在 QianFan 注册页面 创建一个账户,并在 API Keys 页面 生成 token。Spring AI 项目定义了一个名为 spring.ai.qianfan.api-key
和 spring.ai.qianfan.secret-key
的配置属性。你应该将从 API Keys 页面 获取的 API Key
和 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 的工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分,将这些仓库添加到你的构建系统中。
为了帮助管理依赖项,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参考 依赖管理 部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 Azure QianFan Embedding 客户端提供了 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 Embedding 客户端配置重试机制。
属性 | 描述 | 默认值 |
---|---|---|
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 密钥 | - |
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.embedding.base-url
、spring.ai.qianfan.embedding.api-key
和 spring.ai.qianfan.embedding.secret-key
属性,它们也将优先于通用属性。这在你想为不同的模型和不同的模型端点使用不同的 QianFan 账户时非常有用。
:::提示
所有以 spring.ai.qianfan.embedding.options
为前缀的属性都可以在运行时通过在 EmbeddingRequest
调用中添加请求特定的运行时选项来覆盖。
:::
运行时选项
QianFanEmbeddingOptions.java 提供了 QianFan 的配置选项,例如使用的模型等。
默认选项也可以通过 spring.ai.qianfan.embedding.options
属性进行配置。
在启动时使用 QianFanEmbeddingModel
构造函数来设置用于所有嵌入请求的默认选项。在运行时,你可以通过使用 QianFanEmbeddingOptions
实例作为 EmbeddingRequest
的一部分来覆盖默认选项。
例如,要覆盖特定请求的默认模型名称:
EmbeddingResponse embeddingResponse = embeddingClient.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
QianFanEmbeddingOptions.builder()
.model("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 聊天客户端 部分。
接下来,创建一个 QianFanEmbeddingModel
实例,并使用它来计算两个输入文本之间的相似度:
var qianFanApi = new QianFanApi(System.getenv("MINIMAX_API_KEY"), System.getenv("QIANFAN_SECRET_KEY"));
var embeddingClient = new QianFanEmbeddingModel(api, MetadataMode.EMBED, QianFanEmbeddingOptions.builder()
.model("bge_large_en")
.build());
EmbeddingResponse embeddingResponse = this.embeddingClient
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));
QianFanEmbeddingOptions
提供了用于嵌入请求的配置信息。该选项类提供了一个 builder()
方法,以便轻松创建选项。