Skip to main content
Groq 是一个速度极快的,基于 LPU™ 的 AI 推理引擎,支持多种 AI 模型, 支持 工具/函数调用 并提供一个与 OpenAI API 兼容的端点。 Spring AI 通过复用现有的 OpenAI 客户端来集成 Groq。 为此,你需要获取一个 Groq Api 密钥,将 base-url 设置为 https://api.groq.com/openai 并选择一个 提供的 Groq 模型

Spring AI Groq 集成

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 属性设置为 https://api.groq.com/openai
  • 选择 Groq 模型: 使用 spring.ai.openai.chat.model=<模型名称> 属性从可用的 Groq 模型中进行选择。
你可以在 application.properties 文件中设置这些配置属性:
为了在处理 API 密钥等敏感信息时增强安全性,你可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量:
你也可以在应用程序代码中以编程方式设置这些配置:

添加仓库和 BOM

Spring AI 的构件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅构件仓库部分,将这些仓库添加到你的构建系统中。 为了帮助进行依赖管理,Spring AI 提供了一个 BOM (bill of materials),以确保在整个项目中使用一致版本的 Spring AI。请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建系统中。

自动配置

Spring AI 自动配置、启动器模块的构件名称发生了重大变化。 有关更多信息,请参阅升级说明
Spring AI 为 OpenAI 聊天客户端提供 Spring Boot 自动配置。 要启用它,请将以下依赖项添加到项目的 Maven pom.xml 或 Gradle build.gradle 构建文件中:
请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建文件中。

聊天属性

重试属性

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

连接属性

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

配置属性

聊天自动配置的启用和禁用现在通过前缀为 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 调用添加新的、特定于请求的选项来覆盖默认选项。 例如,要为特定请求覆盖默认模型和温度:
除了特定于模型的 OpenAiChatOptions之外,你还可以使用通过 ChatOptions#builder() 创建的可移植 ChatOptions 实例。

函数调用

当选择支持工具/函数的模型之一时,Groq API 端点支持工具/函数调用
检查工具支持的模型

Spring AI Groq 函数

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

工具示例

以下是如何将 Groq 函数调用与 Spring AI 结合使用的简单示例:
在此示例中,当模型需要天气信息时,它将自动调用 weatherFunction bean,该 bean 可以获取实时天气数据。 预期的响应如下所示:“阿姆斯特丹目前的天气是 20 摄氏度,巴黎目前的天气是 25 摄氏度。”
阅读有关 OpenAI 函数调用的更多信息。

多模态

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

示例控制器

创建一个新的 Spring Boot 项目,并将 spring-ai-starter-model-openai 添加到你的 pom (或 gradle) 依赖项中。 src/main/resources 目录下添加一个 application.properties 文件,以启用和配置 OpenAi 聊天模型:
api-key 替换为你的 OpenAI 凭据。
这将创建一个 OpenAiChatModel 实现,你可以将其注入到你的类中。 以下是一个简单的 @Controller 类的示例,该类使用聊天模型进行文本生成。

手动配置

OpenAiChatModel.java 实现了 ChatModelStreamingChatModel,并使用低级 API 连接到 OpenAI 服务。 spring-ai-openai 依赖项添加到项目的 Maven pom.xml 文件中:
或添加到你的 Gradle build.gradle 构建文件中。
请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建文件中。
接下来,创建一个 OpenAiChatModel 并将其用于文本生成:

2. Accordion Groups(折叠组)

适用场景:分组管理多个折叠面板,组织复杂文档内容。 示例用法:
查看 Accordion 文档以获取所有支持的属性。
查看 Accordion 文档以获取所有支持的属性。

文档有误?请协助编辑

发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!