此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT! |
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 |
财产 | 描述 | 违约 |
---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
3 分钟 |
spring.ai.retry.on-client-errors |
如果为 false,则引发 NonTransientAiException,并且不要尝试重试客户端错误代码 |
假 |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表(例如,引发 NonTransientAiException)。 |
空 |
spring.ai.retry.on-http-codes |
应触发重试的 HTTP 状态代码列表(例如,引发 TransientAiException)。 |
空 |
财产 | 描述 | 违约 |
---|---|---|
spring.ai.openai.base-url |
要连接到的 URL |
|
spring.ai.openai.api-key |
API 密钥 |
- |
spring.ai.openai.organization-id |
(可选)您可以指定用于 API 请求的组织。 |
- |
spring.ai.openai.project-id |
(可选)您可以指定用于 API 请求的项目。 |
- |
对于属于多个组织(或通过其旧版用户 API 密钥访问其项目)的用户,您可以选择指定用于 API 请求的组织和项目。 这些 API 请求的使用量将计为指定组织和项目的使用量。 |
财产 | 描述 | 违约 |
---|---|---|
spring.ai.openai.chat.enabled |
启用 OpenAI 聊天模型。 |
真 |
spring.ai.openai.chat.base-url |
可选覆盖spring.ai.openai.base-url以提供特定于聊天的 url |
- |
spring.ai.openai.chat.completions-path |
要附加到 base-url 的路径 |
|
spring.ai.openai.chat.api-key |
Optional 覆盖 spring.ai.openai.api-key 以提供特定于聊天的 api-key |
- |
spring.ai.openai.chat.organization-id |
(可选)您可以指定用于 API 请求的组织。 |
- |
spring.ai.openai.chat.project-id |
(可选)您可以指定用于 API 请求的项目。 |
- |
spring.ai.openai.chat.options.model |
要使用的 OpenAI Chat 模型的名称。您可以在模型之间进行选择,例如:、...有关更多信息,请参阅型号页面。 |
|
spring.ai.openai.chat.options.temperature |
要使用的采样温度,用于控制生成的完成项的明显创造性。较高的值将使输出更具随机性,而较低的值将使结果更加集中和确定。不建议为相同的 completions 请求修改 temperature 和 top_p,因为这两个设置的交互很难预测。 |
0.8 |
spring.ai.openai.chat.options.frequencyPenalty |
介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记,从而降低模型逐字重复同一行的可能性。 |
0.0 英尺 |
spring.ai.openai.chat.options.logitBias |
修改指定标记出现在补全中的可能性。 |
- |
spring.ai.openai.chat.options.max代币 |
在聊天完成中生成的最大令牌数。输入标记和生成的标记的总长度受模型的上下文长度限制。 |
- |
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 模式,这保证模型生成的消息是有效的 JSON。
该类型启用 Structured Outputs,从而保证模型与您提供的 JSON 架构匹配。JSON_SCHEMA类型还需要设置该属性。 |
- |
spring.ai.openai.chat.options.responseFormat.name |
响应格式架构名称。仅适用于 |
custom_schema |
spring.ai.openai.chat.options.responseFormat.schema |
响应格式 JSON 架构。仅适用于 |
- |
spring.ai.openai.chat.options.responseFormat.strict |
响应格式 JSON 架构遵守严格性。仅适用于 |
- |
spring.ai.openai.chat.options.seed |
此功能处于 Beta 阶段。如果指定,我们的系统将尽最大努力确定性地采样,以便具有相同种子和参数的重复请求应返回相同的结果。 |
- |
spring.ai.openai.chat.options.stop |
最多 4 个序列,API 将在其中停止生成更多令牌。 |
- |
spring.ai.openai.chat.options.topP |
使用温度进行采样的替代方法,称为核抽样,其中模型考虑具有top_p概率质量的标记的结果。所以 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 |
函数列表,由其名称标识,用于在单个提示请求中启用函数调用。具有这些名称的函数必须存在于 functionCallbacks 注册表中。 |
- |
spring.ai.openai.chat.options.stream-usage |
(仅用于流媒体)设置为添加一个额外的数据块,其中包含整个请求的令牌使用情况统计信息。此数据块的字段是一个空数组,所有其他数据块也将包含一个 usage 字段,但值为 null。 |
假 |
spring.ai.openai.chat.options.parallel-tool-calls |
是否在工具使用过程中启用并行函数调用。 |
真 |
spring.ai.openai.chat.options.http-headers |
要添加到聊天完成请求的可选 HTTP 标头。要覆盖 api-key,您需要使用标头键,并且必须在键值前面加上 'Bearer ' 前缀。 |
- |
您可以覆盖 common 和 for the 和 implementations.
如果设置了 and 属性,则优先于公共属性。
如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户,这将非常有用。spring.ai.openai.base-url spring.ai.openai.api-key ChatModel EmbeddingModel spring.ai.openai.chat.base-url spring.ai.openai.chat.api-key |
通过向调用添加特定于请求的运行时选项,可以在运行时覆盖所有前缀为 的属性。spring.ai.openai.chat.options Prompt |
除了特定于模型的 OpenAiChatOptions 之外,您还可以使用通过 ChatOptionsBuilder#builder() 创建的可移植 ChatOptions 实例。 |
从 2024 年 6 月 17 日开始,GPT_4_VISION_PREVIEW 将继续仅面向此模型的现有用户提供。如果您不是现有用户,请使用 GPT_4_O 或 GPT_4_TURBO 模型。更多详情请点击这里 |
您也可以传递多个图像。 |
目前,OpenAI 支持 JSON Schema 语言格式的子集。 |
遵循 JSON 架构语言格式的 OpenAI 子集。 |
确保使用注释。
这对于生成将字段准确标记为 的架构至关重要。
虽然这对于 JSON 架构是可选的,但 OpenAI 要求结构化响应正常运行。@JsonProperty(required = true,…) required |
将 替换为您的 OpenAI 凭证。api-key |
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。 |