Groq 聊天
Spring AI 通过重用现有的 OpenAI 客户端与 Groq 集成。 为此，您需要获取 Groq Api 密钥，将 base-url 设置为 api.groq.com/openai 并选择其中一个 提供了 Groq 模型。
| Groq API 与 OpenAI API 不完全兼容。 请注意以下兼容性约束。 此外，目前 Groq 不支持多模式消息。 |
检查 GroqWithOpenAiChatModelIT.java 测试 有关将 Groq 与 Spring AI 结合使用的示例。
先决条件
-
创建 API 密钥。 请访问此处创建 API 密钥。 Spring AI 项目定义了一个名为
spring.ai.openai.api-key，您应该设置为API Key从 groq.com 获得。 -
设置 Groq URL。 您必须设置
spring.ai.openai.base-urlproperty 设置为api.groq.com/openai. -
选择 Groq 模型。 使用
spring.ai.openai.chat.model=<model name>属性来设置 Model。
导出环境变量是设置该配置属性的一种方法：
export SPRING_AI_OPENAI_API_KEY=<INSERT GROQ API KEY HERE>
export SPRING_AI_OPENAI_BASE_URL=https://api.groq.com/openai
export SPRING_AI_OPENAI_CHAT_MODEL=llama3-70b-8192添加存储库和 BOM
Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。 请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 OpenAI Chat 客户端提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml或 Gradlebuild.gradlebuild 文件：
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
聊天属性
重试属性
前缀spring.ai.retry用作属性前缀，允许您为 OpenAI 聊天模型配置重试机制。
| 财产 | 描述 | 违约 |
|---|---|---|
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）。 |
空 |
连接属性
前缀spring.ai.openai用作允许您连接到 OpenAI 的属性前缀。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.openai.base-url |
要连接到的 URL。必须设置为 |
- |
spring.ai.openai.api-key |
Groq API 密钥 |
- |
配置属性
前缀spring.ai.openai.chat是允许您为 OpenAI 配置聊天模型实现的属性前缀。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.openai.chat.enabled |
启用 OpenAI 聊天模型。 |
真 |
spring.ai.openai.chat.base-url |
可选覆盖spring.ai.openai.base-url以提供特定于聊天的 url。必须设置为 |
- |
spring.ai.openai.chat.api-key |
Optional 覆盖 spring.ai.openai.api-key 以提供特定于聊天的 api-key |
- |
spring.ai.openai.chat.options.model |
可用的模型名称包括 |
- |
spring.ai.openai.chat.options.temperature |
要使用的采样温度，用于控制生成的完成项的明显创造性。较高的值将使输出更具随机性，而较低的值将使结果更加集中和确定。不建议为相同的 completions 请求修改 temperature 和 top_p，因为这两个设置的交互很难预测。 |
0.8 |
spring.ai.openai.chat.options.frequencyPenalty |
介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记，从而降低模型逐字重复同一行的可能性。 |
0.0 英尺 |
spring.ai.openai.chat.options.max代币 |
在聊天完成中生成的最大令牌数。输入标记和生成的标记的总长度受模型的上下文长度限制。 |
- |
spring.ai.openai.chat.options.n |
为每个输入消息生成多少个聊天完成选项。请注意，您将根据所有选项中生成的令牌数量付费。将 n 保留为 1 以最大限度地降低成本。 |
1 |
spring.ai.openai.chat.options.presencePenalty |
介于 -2.0 和 2.0 之间的数字。正值根据新标记到目前为止是否出现在文本中来惩罚新标记，从而增加模型讨论新主题的可能性。 |
- |
spring.ai.openai.chat.options.responseFormat |
一个对象，用于指定模型必须输出的格式。设置为 |
- |
spring.ai.openai.chat.options.seed |
此功能处于 Beta 阶段。如果指定，我们的系统将尽最大努力确定性地采样，以便具有相同种子和参数的重复请求应返回相同的结果。 |
- |
spring.ai.openai.chat.options.stop |
最多 4 个序列，API 将在其中停止生成更多令牌。 |
- |
spring.ai.openai.chat.options.topP |
使用温度进行采样的替代方法，称为核抽样，其中模型考虑具有top_p概率质量的标记的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的 token。我们通常建议更改此温度或温度，但不能同时更改两者。 |
- |
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.functions |
函数列表，由其名称标识，用于在单个提示请求中启用函数调用。具有这些名称的函数必须存在于 functionCallbacks 注册表中。 |
- |
spring.ai.openai.chat.options.stream-usage |
（仅用于流媒体）设置为添加一个额外的数据块，其中包含整个请求的令牌使用情况统计信息。这 |
假 |
spring.ai.openai.chat.options.proxy-tool-calls |
如果为true，则 Spring AI 将不会在内部处理函数调用，而是将它们代理给客户端。然后，客户端负责处理函数调用，将它们分派给适当的函数，并返回结果。如果为 false （默认值），则 Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型 |
假 |
所有前缀为spring.ai.openai.chat.options可以通过将特定于请求的运行时选项添加到Prompt叫。 |
运行时选项
OpenAiChatOptions.java 提供模型配置，例如要使用的模型、温度、频率损失等。
启动时，可以使用OpenAiChatModel(api, options)constructor 或spring.ai.openai.chat.options.*性能。
在运行时，您可以通过向Prompt叫。
例如，要覆盖特定请求的默认模型和温度：
ChatResponse response = chatModel.call(
new Prompt(
"Generate the names of 5 famous pirates.",
OpenAiChatOptions.builder()
.withModel("mixtral-8x7b-32768")
.withTemperature(0.4)
.build()
));| 除了特定于模型的 OpenAiChatOptions 之外，您还可以使用通过 ChatOptionsBuilder#builder（） 创建的可移植 ChatOptions 实例。 |
函数调用
Groq API 端点在选择其中一个工具/函数支持模型时支持工具/函数调用。
| 检查工具支持的模型。 |
您可以使用 ChatModel 注册自定义 Java 函数，并让提供的 Groq 模型智能地选择输出包含参数的 JSON 对象，以调用一个或多个已注册的函数。 这是一种将 LLM 功能与外部工具和 API 连接起来的强大技术。
工具示例
以下是如何将 Groq 函数调用与 Spring AI 一起使用的简单示例：
@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);
}
}
}在此示例中，当模型需要天气信息时，它会自动调用weatherFunctionBean 的 Bean 进行访问，然后它可以获取实时天气数据。
预期的响应如下所示：“阿姆斯特丹的天气目前是 20 摄氏度，巴黎的天气目前是 25 摄氏度。
阅读有关 OpenAI 函数调用的更多信息。
Samples控制器
创建一个新的 Spring Boot 项目并添加spring-ai-openai-spring-boot-starter添加到您的 POM（或 Gradle）依赖项中。
添加application.properties文件中的src/main/resources目录中，以启用和配置 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使用 Chat 模型生成文本的类。
@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依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
接下来，创建一个OpenAiChatModel并将其用于文本生成：
var openAiApi = new OpenAiApi("https://api.groq.com/openai", System.getenv("GROQ_API_KEY"));
var openAiChatOptions = OpenAiChatOptions.builder()
.withModel("llama3-70b-8192")
.withTemperature(0.4)
.withMaxTokens(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是 Fluent Options Builder。