Groq Chat

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

Spring AI 通过重用现有的 OpenAI 客户端与 Groq 集成。为此，您需要获取 Groq API 密钥，将基本 URL 设置为 api.groq.com/openai 并选择一个提供的 Groq 模型。

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

查看 GroqWithOpenAiChatModelIT.java 测试以了解使用 Groq 和 Spring AI 的示例。

前提条件

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

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

自动配置

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

  • 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'
}
请参考 依赖管理 部分，将 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.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`

-

spring.ai.openai.chat.api-key

可选地覆盖 spring.ai.openai.api-key 以提供特定于聊天的 api-key

-

spring.ai.openai.chat.options.model

可用的 模型 名称为 `llama3-8b-8192`、`llama3-70b-8192`、`mixtral-8x7b-32768`、`gemma-7b-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

在聊天完成中生成的令牌最大数量。输入令牌和生成的令牌的总长度受模型上下文长度限制。

-

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

指定模型必须输出的格式的对象。设置为{ "type": "json_object" }启用 JSON 模式，这保证了模型生成的 messages 是有效的 JSON。

-

spring.ai.openai.chat.options.seed

此功能处于 Beta 测试阶段。如果指定，我们的系统将尽最大努力确定性地进行采样，以便使用相同的 seed 和参数重复请求应返回相同的结果。

-

spring.ai.openai.chat.options.stop

最多 4 个序列，API 将在此停止生成更多令牌。

-

spring.ai.openai.chat.options.topP

称为核采样的温度采样的替代方法，其中模型考虑具有 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.functions

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

-

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

（仅限流式传输）设置为添加一个包含整个请求的令牌使用情况统计信息的额外块。此块的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提供了模型配置，例如要使用的模型、温度、频率惩罚等。

启动时，可以使用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()
    ));
除了特定于模型的OpenAiChatOptions之外，您还可以使用可移植的ChatOptions实例，该实例使用ChatOptionsBuilder#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-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
将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依赖项添加到您项目的 Mavenpom.xml文件中。

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

或者添加到您的 Gradlebuild.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()
            .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是一个流畅的选项构建器。