Groq 聊天

DeepSeek V3 中英对照 Groq Groq Chat

Groq 是一个基于 LPU™ 的极速 AI 推理引擎，支持多种 AI 模型，支持 Tool/Function Calling 并提供了一个兼容 OpenAI API 的端点。

Spring AI 通过复用现有的 OpenAI 客户端与 Groq 进行集成。为此，你需要获取一个 Groq Api Key，将 base-url 设置为 api.groq.com/openai，并选择提供的 Groq 模型 之一。

备注

Groq API 与 OpenAI API 并不完全兼容。请注意以下 兼容性限制。此外，目前 Groq 不支持多模态消息。

查看 GroqWithOpenAiChatModelIT.java 测试，了解如何在 Spring AI 中使用 Groq 的示例。

先决条件

• 创建 API 密钥。请访问此处创建 API 密钥。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，您应将其设置为从 groq.com 获取的 API Key 的值。

• 设置 Groq URL。您需要将 spring.ai.openai.base-url 属性设置为 [api.groq.com/openai](https://api.groq.com/openai)。

• 选择一个 Groq 模型。使用 spring.ai.openai.chat.options.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

shell

添加仓库和 BOM

Spring AI 的工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分，将这些仓库添加到您的构建系统中。

为了帮助进行依赖管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参考依赖管理部分，将 Spring AI BOM 添加到您的构建系统中。

自动配置

Spring AI 为 OpenAI Chat Client 提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中：

Maven

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

xml

Gradle

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}

groovy

:::提示
请参考依赖管理部分，将 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，抛出 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。必须设置为 [api.groq.com/openai](https://api.groq.com/openai)	-
spring.ai.openai.api-key	Groq API 密钥	-

配置属性

spring.ai.openai.chat 前缀是一个属性前缀，允许你为 OpenAI 配置聊天模型实现。

属性	描述	默认
spring.ai.openai.chat.enabled	启用 OpenAI 聊天模型。	true
spring.ai.openai.chat.base-url	可选地覆盖 spring.ai.openai.base-url 以提供特定于聊天的 URL。必须设置为 [api.groq.com/openai](https://api.groq.com/openai)。	-
spring.ai.openai.chat.api-key	Optional 覆盖了 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	采样温度，用于控制生成内容的表观创造力。较高的值会使输出更加随机，而较低的值会使结果更加集中和确定。不建议在同一生成请求中同时修改温度（temperature）和 top_p 参数，因为这两个设置的交互效果难以预测。	0.8
spring.ai.openai.chat.options.frequencyPenalty	数值范围在 -2.0 到 2.0 之间。正值会根据新词在当前文本中已有的频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。	0.0f
spring.ai.openai.chat.options.maxTokens	在聊天补全中生成的最大 token 数量。输入 token 和生成 token 的总长度受模型上下文长度的限制。	-
spring.ai.openai.chat.options.n	为每个输入消息生成多少个聊天完成选项。请注意，您将根据所有选项中生成的 token 数量进行计费。将 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	此功能处于 Beta 测试阶段。如果指定了该功能，我们的系统将尽最大努力进行确定性采样，以确保使用相同种子和参数的重复请求应返回相同的结果。	-
spring.ai.openai.chat.options.stop	最多 4 个序列，API 将在这些序列处停止生成更多的 token。	-
spring.ai.openai.chat.options.topP	一种替代温度采样的方法是核采样（nucleus sampling），在这种方法中，模型会考虑概率质量达到 top_p 的 token 结果。例如，0.1 表示只考虑概率质量在前 10% 的 token。我们通常建议调整 top_p 或温度参数，但不要同时调整两者。	-
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	（仅适用于流式传输）设置为添加一个额外的数据块，包含整个请求的 token 使用统计信息。此数据块的 choices 字段是一个空数组，所有其他数据块也将包含一个 usage 字段，但其值为 null。	false
spring.ai.openai.chat.options.proxy-tool-calls	如果为 true，Spring AI 将不会在内部处理函数调用，而是将它们代理给客户端。然后由客户端负责处理函数调用，将它们分派到适当的函数，并返回结果。如果为 false（默认值），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型。	false

提示

所有以 spring.ai.openai.chat.options 为前缀的属性都可以在运行时通过向 Prompt 调用添加特定的请求 运行时选项 来覆盖。

运行时选项

OpenAiChatOptions.java 提供了模型配置，例如使用的模型、温度（temperature）、频率惩罚（frequency penalty）等。

在启动时，可以通过 OpenAiChatModel(api, options) 构造函数或 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()
    ));

java

提示

除了特定于模型的 OpenAiChatOptions 之外，你还可以使用一个可移植的 ChatOptions 实例，该实例通过 ChatOptionsBuilder#builder() 创建。

函数调用

选择支持工具/函数调用的模型时，Groq API 端点支持 工具/函数调用。

:::提示
查看工具支持的模型。
:::

你可以向你的 ChatModel 注册自定义的 Java 函数，并让提供的 Groq 模型智能地选择输出一个包含参数的 JSON 对象，以调用一个或多个已注册的函数。这是一种强大的技术，用于将 LLM 的能力与外部工具和 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);
        }
    }
}

java

在这个示例中，当模型需要天气信息时，它会自动调用 weatherFunction bean，然后该 bean 可以获取实时天气数据。预期的响应如下：“阿姆斯特丹的当前气温为 20 摄氏度，巴黎的当前气温为 25 摄氏度。”

了解更多关于 OpenAI Function Calling 的信息。

多模态

备注

目前 Groq API 不支持媒体内容。

示例控制器

创建 一个新的 Spring Boot 项目，并将 spring-ai-openai-spring-boot-starter 添加到你的 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

application.properties

提示

将 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);
    }
}

java

手动配置

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>

xml

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}

groovy

:::提示
请参考依赖管理部分，将 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."));

java

OpenAiChatOptions 提供了聊天请求的配置信息。OpenAiChatOptions.Builder 是一个流式的选项构建器。