Groq 对话

Groq 是一个基于 LPU™ 的极速 AI 推理引擎，支持多种 AI 模型，支持 工具/函数调用，并暴露一个与 OpenAI API 兼容的端点。

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

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

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

前提条件

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

  • 设置 Groq URL。你必须将 spring.ai.openai.base-url 属性设置为 api.groq.com/openai。

  • 选择一个 Groq 模型。使用 spring.ai.openai.chat.options.model=<model name> 属性来设置模型。

导出环境变量是设置该配置属性的一种方式

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 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 仓库 部分将这些仓库添加到你的构建系统中。

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

自动配置

Spring AI 自动配置、Starter 模块的工件名称发生了重大变化。详情请参考 升级说明 获取更多信息。

Spring AI 为 OpenAI 对话客户端提供了 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，则抛出 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

-

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 对话模型。

true

spring.ai.openai.chat

启用 OpenAI 对话模型。

openai

spring.ai.openai.chat.base-url

可选，覆盖 spring.ai.openai.base-url 以提供对话特定的 URL。必须设置为 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

用于控制生成完成文本的表观创造力的采样温度。较高的值会使输出更随机，而较低的值会使结果更集中和确定。不建议在同一完成请求中同时修改 temperature 和 top_p，因为这两个设置的相互作用难以预测。

0.8

spring.ai.openai.chat.options.frequencyPenalty

介于 -2.0 和 2.0 之间的数字。正值根据新 token 在文本中的现有频率进行惩罚，降低模型逐字重复同一行的可能性。

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 阶段。如果指定，我们的系统将尽最大努力进行确定性采样，以便具有相同 seed 和参数的重复请求应返回相同的结果。

-

spring.ai.openai.chat.options.stop

最多 4 个序列，API 在遇到这些序列时将停止生成更多 token。

-

spring.ai.openai.chat.options.topP

一种替代温度采样的核采样方法，模型在此方法中考虑累积概率达到 top_p 的 token 的结果。因此，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

要在单个 prompt 请求中启用函数调用的函数列表，通过其名称标识。具有这些名称的函数必须存在于 functionCallbacks 注册表中。

-

spring.ai.openai.chat.options.stream-usage

（仅用于流式传输）设置此项以添加一个额外的 chunk，其中包含整个请求的 token 使用统计信息。此 chunk 的 choices 字段为空数组，所有其他 chunk 也将包含一个 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 提供了模型配置，例如要使用的模型、温度、频率惩罚等。

启动时，默认选项可以通过 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 端点支持 工具/函数调用，前提是选择支持工具/函数的模型。

查看工具 支持的模型。
spring ai groq functions 2

你可以在 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);
        }
    }
}

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

阅读更多关于 OpenAI 函数调用。

多模态

目前 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，并使用 [低级 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 是一个流畅的选项构建器。