一、Groq 聊天

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

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

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

有关使用 Groq 与 Spring AI 的示例，请查阅 GroqWithOpenAiChatModelIT.java 测试。

二、先决条件

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

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

• 选择 Groq 模型： 使用 spring.ai.openai.chat.model= 属性从可用的 Groq 模型中进行选择。

您可以在 application.properties 文件中设置这些配置属性：

spring.ai.openai.api-key=<您的-groq-api-密钥>
spring.ai.openai.base-url=https://api.groq.com/openai
spring.ai.openai.chat.model=llama3-70b-8192

为了在处理 API 密钥等敏感信息时增强安全性，您可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量：

# 在 application.yml 中
spring:
  ai:
    openai:
      api-key: ${GROQ_API_KEY}
      base-url: ${GROQ_BASE_URL}
      chat:
        model: ${GROQ_MODEL}

# 在您的环境或 .env 文件中
export GROQ_API_KEY=<您的-groq-api-密钥>
export GROQ_BASE_URL=https://api.groq.com/openai
export GROQ_MODEL=llama3-70b-8192

您也可以在应用程序代码中以编程方式设置这些配置：

// 从安全来源或环境变量获取配置
String apiKey = System.getenv("GROQ_API_KEY");
String baseUrl = System.getenv("GROQ_BASE_URL");
String model = System.getenv("GROQ_MODEL");

2.1 添加仓库和 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

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

Gradle

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

请参阅 “依赖管理” 部分，将 Spring AI BOM 添加到您的构建文件中。

3.1 聊天属性

3.1.1 重试属性

前缀 spring.ai.retry 用作属性前缀，允许您为 OpenAI 聊天模型配置重试机制。

3.1.2 连接属性

前缀 spring.ai.openai 用作属性前缀，允许您连接到 OpenAI。

3.1.3 配置属性

聊天自动配置的启用和禁用现在通过前缀为 spring.ai.model.chat 的顶级属性进行配置。

• 要启用：spring.ai.model.chat=openai（默认已启用）。

• 要禁用：spring.ai.model.chat=none（或任何不匹配 openai 的值）。

此项更改是为了支持配置多个模型。

前缀 spring.ai.openai.chat 是用于配置 OpenAI 聊天模型实现的属性前缀。

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

四、运行时选项

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

在启动时，可以通过 OpenAiChatModel(api, options) 构造函数或 spring.ai.openai.chat.options.* 属性来配置默认选项。

在运行时，您可以通过向 Prompt 调用添加新的、特定于请求的选项来覆盖默认选项。例如，为特定请求覆盖默认模型和温度：

ChatResponse response = chatModel.call(
    new Prompt(
        "生成 5 个著名海盗的名字。",
        OpenAiChatOptions.builder()
            .model("mixtral-8x7b-32768")
            .temperature(0.4)
        .build()
    ));

除了模型特定的 OpenAiChatOptions，您还可以使用可移植的 ChatOptions 实例，该实例通过 ChatOptions#builder() 创建。

五、函数调用

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

请查阅 工具支持模型。

您可以将自定义 Java 函数注册到您的 ChatModel，并让提供的 Groq 模型智能地选择输出包含调用一个或多个已注册函数参数的 JSON 对象。这是一种将 LLM 功能与外部工具和 API 连接的强大技术。

5.1 工具示例

以下是一个如何使用 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("阿姆斯特丹和巴黎的天气如何？")
                .functions("weatherFunction") // 通过 bean 名称引用。
                .call()
                .content();

            System.out.println(response);
        };
    }

    @Bean
    @Description("获取指定地点的天气")
    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 = "给我讲个笑话") String message) {
        return Map.of("generation", this.chatModel.call(message));
    }

    @GetMapping("/ai/generateStream")
    public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "给我讲个笑话") 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("生成 5 个著名海盗的名字。"));

// 或者用于流式响应
Flux<ChatResponse> response = this.chatModel.stream(
    new Prompt("生成 5 个著名海盗的名字。"));

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