Groq Chat
Spring AI 通过重用现有的 OpenAI 客户端与 Groq 集成。为此，您需要获取一个 Groq API 密钥，将基础 URL 设置为 api.groq.com/openai，并选择提供的 Groq 模型 之一。
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
spring.ai.openai.chat.model=llama3-70b-8192
为了增强处理敏感信息（如API密钥）时的安全性，您可以使用Spring表达式语言（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
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 仓库。请参考构件仓库章节，将这些仓库添加至您的构建系统中。
为了辅助依赖管理，Spring AI 提供了一个物料清单（BOM），以确保在整个项目中使用统一版本的 Spring AI。请参考依赖管理章节，将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 的自动配置和 starter 模块的构件名称发生了重大变化。更多信息请参考升级说明。
Spring AI 为 OpenAI Chat 客户端提供了 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 秒 |
| spring.ai.retry.backoff.multiplier | 退避间隔的乘数因子。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避时长。 | 3 分钟 |
| spring.ai.retry.on-client-errors | 如果为 false，对于 4xx 客户端错误码，将抛出 NonTransientAiException 且不尝试重试。 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试（例如，将抛出 NonTransientAiException）的 HTTP 状态码列表。 | empty |
| spring.ai.retry.on-http-codes | 应触发重试（例如，将抛出 TransientAiException）的 HTTP 状态码列表。 | empty |
连接属性
前缀 spring.ai.openai 用作属性前缀，允许您连接到 OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.base-url | 要连接的 URL。必须设置为 https://api.groq.com/openai | - |
| spring.ai.openai.api-key | Groq API 密钥 | - |
配置属性
聊天自动配置的启用和禁用现在通过以 spring.ai.model.chat 为前缀的顶级属性进行配置。
启用方式：spring.ai.model.chat=openai（默认已启用）
禁用方式：spring.ai.model.chat=none（或任何与 openai 不匹配的值）
此项变更是为了支持配置多个模型。
前缀 spring.ai.openai.chat 是用于配置 OpenAI 聊天模型实现的属性前缀。
| 属性 | 描述 | 默认 |
|---|---|---|
| spring.ai.openai.chat.enabled (已移除，不再有效) | 启用 OpenAI 聊天模型。 | 真 |
| spring.ai.openai.chat | 启用 OpenAI 聊天模型。 | openai |
| spring.ai.openai.chat.base-url | Optional overrides the spring.ai.openai.base-url to provide chat specific url. Must be set to https://api.groq.com/openai | - |
| spring.ai.openai.chat.api-key | 可选地覆盖 spring.ai.openai.api-key 以提供特定于聊天的 API 密钥。 | - |
| spring.ai.openai.chat.options.model | 可用的模型名称包括 llama3-8b-8192、llama3-70b-8192、mixtral-8x7b-32768、gemma2-9b-it。 | - |
| spring.ai.openai.chat.options.temperature | 用于控制生成内容表面创造性的采样温度。较高的值会使输出更随机，而较低的值会使结果更集中且具有确定性。不建议在同一个补全请求中同时调整温度和 top_p 参数，因为这两个设置的相互作用难以预测。 | 0.8 |
| spring.ai.openai.chat.options.frequencyPenalty | 数值范围在 -2.0 到 2.0 之间。正值会根据新词元在现有文本中的出现频率进行惩罚，从而降低模型逐字重复同一行的可能性。 | 0.0f |
| spring.ai.openai.chat.options.maxTokens | 聊天补全中生成的最大令牌数量。输入令牌和生成令牌的总长度受模型上下文长度的限制。 | - |
| spring.ai.openai.chat.options.n | 为每个输入消息生成多少个聊天补全选项。请注意，系统将根据所有选项中生成的令牌总数计费。请将 n 保持为 1 以最小化成本。 | 1 |
| spring.ai.openai.chat.options.presencePenalty | 介于 -2.0 和 2.0 之间的数值。正值会根据新 token 是否已在文本中出现来对其进行惩罚，从而增加模型谈论新话题的可能性。 | - |
| spring.ai.openai.chat.options.responseFormat | 一个指定模型必须输出的格式的对象。设置为 { "type": "json_object" } 可启用 JSON 模式，该模式保证模型生成的消息是有效的 JSON。 | - |
| spring.ai.openai.chat.options.seed | 此功能处于测试阶段。如果指定了种子，我们的系统将尽力进行确定性采样，这样使用相同种子和参数的重复请求应该会返回相同的结果。 | - |
| spring.ai.openai.chat.options.stop | 最多支持 4 个序列，当 API 检测到这些序列时将停止生成后续 token。 | - |
| spring.ai.openai.chat.options.topP | 另一种采样方法是温度采样的替代方案，称为核心采样（nucleus sampling），其中模型仅考虑累积概率质量达到 top_p 的候选词元。例如，0.1 表示仅考虑构成最高 10% 概率质量的词元。我们通常建议调整此参数或温度参数，但不要同时调整两者。 | - |
| spring.ai.openai.chat.options.tools | 模型可调用的工具列表。目前，仅支持函数作为工具。使用此列表来提供模型可为其生成 JSON 输入的函数列表。 | - |
| spring.ai.openai.chat.options.toolChoice | 控制模型调用哪个（如果有）函数。none 表示模型不会调用函数，而是生成消息。auto 表示模型可以在生成消息或调用函数之间进行选择。通过 {"type": "function", "function": {"name": "my_function"}} 指定特定函数会强制模型调用该函数。当没有函数存在时，默认值为 none。当存在函数时，默认值为 auto。 | - |
| spring.ai.openai.chat.options.user | 一个代表您终端用户的唯一标识符，可以帮助OpenAI监控和检测滥用行为。 | - |
| spring.ai.openai.chat.options.stream-usage | （仅适用于流式传输）设置为在请求结束时添加一个包含整个请求的令牌使用统计数据的额外数据块。此数据块的 choices 字段为空数组，而所有其他数据块也将包含一个 usage 字段，但该字段的值为 null。 | false |
| spring.ai.openai.chat.options.tool-names | 启用单次提示请求中函数调用的工具列表，按名称标识。具有这些名称的工具必须存在于 ToolCallback 注册表中。 | - |
| spring.ai.openai.chat.options.tool-callbacks | ChatModel中注册的工具回调函数。 | - |
| spring.ai.openai.chat.options.internal-tool-execution-enabled | 如果为 false，Spring AI 将不会在内部处理工具调用，而是将其代理给客户端。此时由客户端负责处理工具调用、将其分派到适当的函数并返回结果。如果为 true（默认值），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型 | 真 |
:::提示
所有以 spring.ai.openai.chat.options 为前缀的属性，都可以在运行时通过向 Prompt 调用添加特定请求的运行时选项来覆盖。
:::
运行时选项
OpenAiChatOptions.java 提供了模型配置选项，例如要使用的模型、温度参数、频率惩罚等。
在启动时，可以通过 OpenAiChatModel(api, options) 构造函数或 spring.ai.openai.chat.options.* 属性来配置默认选项。
在运行时，你可以通过向 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 实例，该实例通过 ChatOptions#builder() 创建。
:::
函数调用
选择支持工具/函数调用的模型时，Groq API 端点支持工具/函数调用。
:::提示
查看工具支持的模型。
:::
您可以将自定义的Java函数注册到ChatModel中，让提供的Groq模型智能地选择输出包含调用一个或多个已注册函数参数的JSON对象。这是一种将大语言模型能力与外部工具及API相连接的有效方法。
工具示例
以下是使用 Spring AI 调用 Groq 函数的一个简单示例：
@SpringBootApplication
public class GroqApplication {
public static void main(String[] args) {
SpringApplication.run(GroqApplication.class, args);
}
@Bean
CommandLineRunner runner(ChatClient.Builder chatClientBuilder) {
return args -> {
var chatClient = chatClientBuilder.build();
var response = chatClient.prompt()
.user("What is the weather in Amsterdam and Paris?")
.functions("weatherFunction") // reference by bean name.
.call()
.content();
System.out.println(response);
};
}
@Bean
@Description("Get the weather in location")
public Function<WeatherRequest, WeatherResponse> weatherFunction() {
return new MockWeatherService();
}
public static class MockWeatherService implements Function<WeatherRequest, WeatherResponse> {
public record WeatherRequest(String location, String unit) {}
public record WeatherResponse(double temp, String unit) {}
@Override
public WeatherResponse apply(WeatherRequest request) {
double temperature = request.location().contains("Amsterdam") ? 20 : 25;
return new WeatherResponse(temperature, request.unit);
}
}
}
在此示例中，当模型需要天气信息时，它会自动调用 weatherFunction bean，从而获取实时天气数据。预期的响应如下："阿姆斯特丹当前天气为 20 摄氏度，巴黎当前天气为 25 摄氏度。"
了解更多关于 OpenAI Function Calling 的信息。
多模态
目前 Groq API 暂不支持媒体内容。
示例控制器
创建 一个新的 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
spring.ai.openai.chat.options.model=llama3-70b-8192
spring.ai.openai.chat.options.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 服务。
将 spring-ai-openai 依赖项添加到项目的 Maven pom.xml 文件中：
<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 openAiApi = new OpenAiApi("https://api.groq.com/openai", System.getenv("GROQ_API_KEY"));
var openAiChatOptions = OpenAiChatOptions.builder()
.model("llama3-70b-8192")
.temperature(0.4)
.maxTokens(200)
.build();
var chatModel = new OpenAiChatModel(this.openAiApi, this.openAiChatOptions);
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 是流畅的选项构建器。