Groq 聊天
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.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。必须设置为 https://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。必须设置为 https://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 、gemma2-9b-it 。 | - |
spring.ai.openai.chat.options.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 模式,该模式可确保模型生成的消息是有效的 JSON。 | - |
spring.ai.openai.chat.options.seed | 此功能处于测试阶段。如果指定,我们的系统将尽最大努力进行确定性采样,以便具有相同种子和参数的重复请求应返回相同的结果。 | - |
spring.ai.openai.chat.options.stop | API 将停止生成更多标记的最多 4 个序列。 | - |
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
调用添加新的、特定于请求的选项来覆盖默认选项。
例如,要为特定请求覆盖默认模型和温度:
除了特定于模型的 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 实现了 ChatModel
和 StreamingChatModel
,并使用低级 API 连接到 OpenAI 服务。
将 spring-ai-openai
依赖项添加到项目的 Maven pom.xml
文件中:
或添加到你的 Gradle build.gradle
构建文件中。
请参阅依赖管理部分,将 Spring AI BOM 添加到你的构建文件中。
接下来,创建一个 OpenAiChatModel
并将其用于文本生成:
2. Accordion Groups(折叠组)
适用场景:分组管理多个折叠面板,组织复杂文档内容。
示例用法:
文档有误?请协助编辑
发现文档问题?点击此处直接在 GitHub 上编辑并提交 PR,帮助我们改进文档!