Groq Chat
Spring AI 通过复用现有的 OpenAI 客户端，与 Groq 进行集成。为此，你需要获取一个 Groq Api Key，将 base-url 设置为 api.groq.com/openai/v1，并选择其中一个提供的 Groq models。
Groq API 与 OpenAI API 并不完全兼容。请注意以下兼容性限制。此外，目前 Groq 不支持多模态消息。
查看 GroqWithOpenAiChatModelIT.java 中的测试用例，以了解在 Spring AI 中使用 Groq 的示例。
前提条件
您可以在 application.properties 文件中设置这些配置属性：
spring.ai.openai.api-key=<your-groq-api-key>
spring.ai.openai.base-url=https://api.groq.com/openai/v1
spring.ai.openai.chat.model=llama3-70b-8192
在处理 API 密钥等敏感信息时，为了增强安全性，您可以使用 Spring Expression Language (SpEL) 来引用自定义环境变量：
# In application.yml
spring:
ai:
openai:
api-key: ${GROQ_API_KEY}
base-url: ${GROQ_BASE_URL}
chat:
model: ${GROQ_MODEL}
# In your environment or .env file
export GROQ_API_KEY=<your-groq-api-key>
export GROQ_BASE_URL=https://api.groq.com/openai/v1
export GROQ_MODEL=llama3-70b-8192
你也可以在应用程序代码中以编程方式设置这些配置：
// Retrieve configuration from secure sources or environment variables
String apiKey = System.getenv("GROQ_API_KEY");
String baseUrl = System.getenv("GROQ_BASE_URL");
String model = System.getenv("GROQ_MODEL");
添加仓库和 BOM
Spring AI 构件已发布至 Maven Central 和 Spring Snapshot 仓库。请参考 Artifact Repositories 部分，将这些仓库添加到你的构建系统中。
为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致版本的 Spring AI。请参阅 Dependency Management 部分，将 Spring AI BOM 添加到你的构建系统中。
自动配置
Spring AI 自动配置和 starter 模块的 artifact 名称发生了重大变化。更多信息请参考 升级说明。
Spring AI 为 OpenAI Chat Client 提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中：
- Maven
- Gradle
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
请参考 依赖管理 章节，将 Spring AI BOM 添加到您的构建文件中。
聊天属性
重试属性
前缀 spring.ai.retry 用作属性前缀，用于配置 OpenAI 聊天模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.retry.max-attempts | 最大重试次数。 | 10 |
| spring.ai.retry.backoff.initial-interval | 指数退避策略的初始休眠时长。 | 2 sec. |
| spring.ai.retry.backoff.multiplier | 退避间隔倍数。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避时长。 | 3 min. |
| 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.openai 用作属性前缀，用于连接 OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.base-url | 要连接的 URL。必须设置为 https://api.groq.com/openai/v1 | - |
| spring.ai.openai.api-key | Groq API Key | - |
配置属性
聊天自动配置的启用和禁用现在通过具有 spring.ai.model.chat 前缀的顶层属性进行配置。
要启用，设置 spring.ai.model.chat=openai（默认情况下已启用）
要禁用，设置 spring.ai.model.chat=none（或任何与 openai 不匹配的值）
此项更改旨在支持多个模型的可配置性。
前缀 spring.ai.openai.chat 是用于配置 OpenAI 聊天模型实现的属性前缀。
| 属性 | 描述 | Default |
|---|---|---|
| spring.ai.openai.chat.enabled（已移除，不再有效） | 启用 OpenAI 聊天模型。 | true |
| spring.ai.openai.chat | 启用 OpenAI 聊天模型。 | openai |
| spring.ai.openai.chat.base-url | 可选地覆盖 spring.ai.openai.base-url 以提供特定的聊天 URL。必须设置为 https://api.groq.com/openai/v1 | - |
| spring.ai.openai.chat.api-key | Optional 用于覆盖 spring.ai.openai.api-key，以提供特定的聊天 api-key。 | - |
| spring.ai.openai.chat.model | 可用模型的名称为 llama3-8b-8192、llama3-70b-8192、mixtral-8x7b-32768、gemma2-9b-it。 | - |
| spring.ai.openai.chat.temperature | 用于控制生成补全的明显创造力的采样温度。较高的值会使输出更具随机性，而较低的值则会使结果更集中、更具确定性。不建议在同一补全请求中同时修改 temperature 和 top_p，因为这两个设置的交互作用难以预测。 | 0.8 |
| spring.ai.openai.chat.frequency-penalty | -2.0 与 2.0 之间的数值。正值会根据 token 在文本中出现的现有频率对其进行惩罚，从而降低模型逐字重复相同行的可能性。 | 0.0f |
| spring.ai.openai.chat.max-tokens | 用于生成补全结果的最大令牌数。输入令牌与生成令牌的总长度受限于模型的上下文长度。 | - |
| spring.ai.openai.chat.n | 要为每个输入消息生成多少条聊天补全选项。请注意，费用将基于所有选项中生成的 token 总数进行计算。建议将 n 设为 1 以降低成本。 | 1 |
| spring.ai.openai.chat.presence-penalty | 取值范围为 -2.0 到 2.0 之间的数字。正值会根据新标记在当前文本中的出现情况对其进行惩罚，从而增加模型谈论新话题的可能性。 | - |
| spring.ai.openai.chat.response-format | 指定模型输出格式的对象。设置为 { "type": "json_object" } 可启用 JSON 模式，确保模型生成的消息是有效的 JSON。 | - |
| spring.ai.openai.chat.seed | 此功能处于 Beta 阶段。如果指定了该参数，我们的系统将尽力进行确定性采样，即使用相同的 seed 和参数重复请求时，应返回相同的结果。 | - |
| spring.ai.openai.chat.stop | 最多 4 个序列，API 将停止生成更多 token。 | - |
| spring.ai.openai.chat.top-p | 一种替代温度采样的方法称为核采样（nucleus sampling），其中模型仅考虑 top_p 概率质量范围内的 token 结果。因此，0.1 表示仅考虑占据前 10% 概率质量的 token。我们通常建议只调整 top_p 或 temperature 其中之一，而不要同时调整两者。 | - |
| spring.ai.openai.chat.tools | 模型可能调用的工具列表。当前，仅支持函数作为工具。使用此字段提供模型可能生成 JSON 输入参数的函数列表。 | - |
| spring.ai.openai.chat.tool-choice | 控制模型调用的函数（如果有）。none 表示模型不会调用函数，而是生成消息。auto 表示模型可以选择生成消息或调用函数。通过指定特定函数（例如 {"type: "function", "function": {"name": "my_function"}}）可以强制模型调用该函数。当不存在任何函数时，默认值为 none；当存在函数时，默认值为 auto。 | - |
| spring.ai.openai.chat.user | 表示终端用户的唯一标识符，有助于 OpenAI 监控和检测滥用行为。 | - |
| spring.ai.openai.chat.stream-usage | （仅适用于流式处理）设置为在请求结束时添加一个包含整个请求的 token 使用统计信息的额外块。此块的 choices 字段为空数组，其他所有块也将包含一个 usage 字段，但其值为 null。 | false |
| spring.ai.openai.chat.tool-callbacks | Tool Callbacks 用于注册到 ChatModel。 | - |
所有以 spring.ai.openai.chat 为前缀的属性，都可以通过在 Prompt 调用中添加请求特定的 运行时选项 在运行时被覆盖。
运行时选项
OpenAiChatOptions.java 提供了模型配置，例如使用的模型、temperature、frequency penalty 等。
在启动时，可以使用 OpenAiChatModel(api, options) 构造函数或 spring.ai.openai.chat.* 属性来配置默认选项。
在运行时，你可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。例如，要为特定请求覆盖默认的模型和温度：
ChatResponse response = chatModel.call(
new Prompt(
"Generate the names of 5 famous pirates.",
OpenAiChatOptions.builder()
.model("mixtral-8x7b-32768")
.temperature(0.4)
.build()
));
除了模型特定的 OpenAiChatOptions，你还可以使用通过 ChatOptions#builder() 创建的可移植的 ChatOptions 实例。
工具调用
当所选模型支持时，Groq 支持工具调用（tool calling）。Spring AI 负责处理工具执行循环。
请查看 支持模型。
对于大多数应用，请使用带有自动注册的 ToolCallingAdvisor 的 ChatClient — 参见 Tool Calling。若需进行低级别控制并自行驱动循环，请参见 ChatModel Tool Calling。
多模态
当前 Groq API 不支持媒体内容。
示例控制器
使用 Create 创建一个新的 Spring Boot 项目，并将 spring-ai-starter-model-openai 添加到 pom（或 gradle）依赖中。
在 src/main/resources 目录下添加一个 application.properties 文件，用于启用并配置 OpenAI 聊天模型：
spring.ai.openai.api-key=<GROQ_API_KEY>
spring.ai.openai.base-url=https://api.groq.com/openai/v1
spring.ai.openai.chat.model=llama3-70b-8192
spring.ai.openai.chat.temperature=0.7
将 api-key 替换为你的 OpenAI 凭证。
这将创建一个 OpenAiChatModel 实现，你可以将其注入到你的类中。下面是一个简单的 @Controller 类示例，它使用聊天模型进行文本生成。
@RestController
public class ChatController {
private final OpenAiChatModel chatModel;
@Autowired
public ChatController(OpenAiChatModel chatModel) {
this.chatModel = chatModel;
}
@GetMapping("/ai/generate")
public Map generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
return Map.of("generation", this.chatModel.call(message));
}
@GetMapping("/ai/generateStream")
public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
Prompt prompt = new Prompt(new UserMessage(message));
return this.chatModel.stream(prompt);
}
}
手动配置
OpenAiChatModel 实现了 ChatModel 和 StreamingChatModel，并使用 [low-level-api] 连接 OpenAI 服务。
在你的 Maven 项目中的 pom.xml 文件里添加 spring-ai-openai 依赖：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>
或添加到你的 Gradle build.gradle 构建文件中。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}
有关将 Spring AI BOM 添加到构建文件，请参考依赖管理部分。
接下来，创建一个 OpenAiChatModel 并用于文本生成：
var chatModel = OpenAiChatModel.builder()
.options(OpenAiChatOptions.builder()
.baseUrl("https://api.groq.com/openai/v1")
.apiKey(System.getenv("GROQ_API_KEY"))
.model("llama3-70b-8192")
.temperature(0.4)
.maxTokens(200)
.build())
.build();
ChatResponse response = this.chatModel.call(
new Prompt("Generate the names of 5 famous pirates."));
// Or with streaming responses
Flux<ChatResponse> response = this.chatModel.stream(
new Prompt("Generate the names of 5 famous pirates."));
OpenAiChatOptions 提供聊天请求的配置信息。OpenAiChatOptions.Builder 是一个流式选项构建器。