此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT! |
千帆聊天
Spring AI 支持 QianFan 的各种 AI 语言模型。您可以与 QianFan 语言模型交互,并基于 QianFan 模型创建多语言对话助手。
先决条件
您需要使用 QianFan 创建一个 API 才能访问 QianFan 语言模型。
在 QianFan 注册页面创建账号,并在 API Keys 页面生成 Token。
Spring AI 项目定义了一个名为 和 的配置属性。
您应该设置为 和 从 API 密钥页面获取的值。
导出环境变量是设置该配置属性的一种方法:spring.ai.qianfan.api-key
spring.ai.qianfan.secret-key
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 工件发布在 Spring Milestone 和 Snapshot 存储库中。 请参阅 Repositories 部分,将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 QianFan Chat 客户端提供了 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'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 |
聊天属性
重试属性
前缀用作属性前缀,用于配置 QianFan Chat 客户端的重试机制。spring.ai.retry
财产 | 描述 | 违约 |
---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
3 分钟 |
spring.ai.retry.on-client-errors |
如果为 false,则引发 NonTransientAiException,并且不要尝试重试客户端错误代码 |
假 |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。 |
空 |
spring.ai.retry.on-http-codes |
应触发重试的 HTTP 状态代码列表(例如,引发 TransientAiException)。 |
空 |
连接属性
前缀用作用于连接到 QianFan 的属性前缀。spring.ai.qianfan
财产 | 描述 | 违约 |
---|---|---|
spring.ai.qianfan.base-url |
要连接到的 URL |
|
spring.ai.qianfan.api-key |
API 密钥 |
- |
spring.ai.qianfan.secret-key |
密钥 |
- |
配置属性
前缀是属性前缀,用于为 QianFan 配置聊天客户端实现。spring.ai.qianfan.chat
财产 | 描述 | 违约 |
---|---|---|
spring.ai.qianfan.chat.enabled |
开启 QianFan 聊天客户端。 |
真 |
spring.ai.qianfan.chat.base-url |
可选覆盖spring.ai.qianfan.base-url以提供特定于聊天的url |
|
spring.ai.qianfan.chat.api-key |
Optional 覆盖 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 |
这是要使用的 QianFan Chat 模型 |
|
spring.ai.qianfan.chat.options.maxTokens |
在聊天完成中生成的最大令牌数。输入标记和生成的标记的总长度受模型的上下文长度限制。 |
- |
spring.ai.qianfan.chat.options.temperature |
要使用的采样温度,用于控制生成的完成项的明显创造性。较高的值将使输出更具随机性,而较低的值将使结果更加集中和确定。不建议为相同的 completions 请求修改 temperature 和 top_p,因为这两个设置的交互很难预测。 |
0.7 |
spring.ai.qianfan.chat.options.topP |
使用温度进行采样的替代方法,称为核抽样,其中模型考虑具有top_p概率质量的标记的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的 token。我们通常建议更改此温度或温度,但不能同时更改两者。 |
1.0 |
spring.ai.qianfan.chat.options.presencePenalty |
介于 -2.0 和 2.0 之间的数字。正值根据新标记到目前为止是否出现在文本中来惩罚新标记,从而增加模型讨论新主题的可能性。 |
0.0 英尺 |
spring.ai.qianfan.chat.options.frequencyPenalty |
介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记,从而降低模型逐字重复同一行的可能性。 |
0.0 英尺 |
spring.ai.qianfan.chat.options.stop |
该模型将停止生成 stop 指定的字符,目前仅支持 [“stop_word1”] 格式的单个停用词 |
- |
您可以覆盖 common 和 for implementations。
的 和 properties (如果设置) 优先于公共属性。
如果您想为不同的模型和不同的模型终端节点使用不同的 QianFan 帐户,这将非常有用。spring.ai.qianfan.base-url spring.ai.qianfan.api-key spring.ai.qianfan.secret-key ChatClient spring.ai.qianfan.chat.base-url spring.ai.qianfan.chat.api-key spring.ai.qianfan.chat.secret-key |
通过向调用添加特定于请求的运行时选项,可以在运行时覆盖所有前缀为 的属性。spring.ai.qianfan.chat.options Prompt |
运行时选项
QianFanChatOptions.java 提供模型配置,例如要使用的模型、温度、频率损失等。
启动时,可以使用 constructor 或 properties 配置默认选项。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 之外,您还可以使用通过 ChatOptionsBuilder#builder() 创建的可移植 ChatOptions 实例。 |
Samples控制器
创建一个新的 Spring Boot 项目,并将 添加到您的 pom(或 gradle)依赖项中。spring-ai-qianfan-spring-boot-starter
在目录下添加一个文件,以启用和配置 QianFan Chat 客户端:application.properties
src/main/resources
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
将 and 替换为您的 QianFan 凭证。api-key secret-key |
这将创建一个可以注入到类中的实现。
下面是一个使用聊天客户端生成文本的简单类的示例。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 实现了 and,并使用底层 QianFanApi Client 连接 QianFan 服务。ChatClient
StreamingChatClient
将依赖项添加到项目的 Maven 文件中:spring-ai-qianfan
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'
}
请参阅 Dependency Management 部分,将 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."));
这提供了聊天请求的配置信息。
这是 fluent 选项构建器。QianFanChatOptions
QianFanChatOptions.Builder
低级 QianFanApi 客户端
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 测试提供了一些如何使用轻量级库的一般示例。