OpenAI 聊天

DeepSeek V3 中英对照 OpenAI OpenAI Chat

Spring AI 支持来自 OpenAI 的各种 AI 语言模型，OpenAI 是 ChatGPT 背后的公司。由于 OpenAI 创建了行业领先的文本生成模型和嵌入技术，它在激发人们对 AI 驱动的文本生成的兴趣方面发挥了重要作用。

前提条件

你需要创建一个与 OpenAI 的 API 来访问 ChatGPT 模型。请在 OpenAI 注册页面 创建一个账户，并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你需要将其设置为从 openai.com 获取的 API Key 的值。导出环境变量是设置该配置属性的一种方式：

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

shell

添加仓库和 BOM

Spring AI 的工件已发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分，将这些仓库添加到您的构建系统中。

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

自动配置

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

Maven

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

xml

Gradle

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

groovy

提示

请参考 依赖管理 部分，将 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.openai.com
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 是用于配置 OpenAI 聊天模型实现的属性前缀。

属性	描述	默认
spring.ai.openai.chat.enabled	启用 OpenAI 聊天模型。	true
spring.ai.openai.chat.base-url	spring.ai.openai.base-url 属性的可选覆盖，用于提供特定于聊天的 URL。	-
spring.ai.openai.chat.completions-path	追加到基础 URL 的路径。	/v1/chat/completions
spring.ai.openai.chat.api-key	spring.ai.openai.api-key 的可选覆盖项，用于提供特定于聊天的 API 密钥。	-
spring.ai.openai.chat.organization-id	可选地，你可以指定用于 API 请求的组织。	-
spring.ai.openai.chat.project-id	可选地，你可以指定用于 API 请求的项目。	-
spring.ai.openai.chat.options.model	使用的 OpenAI 聊天模型的名称。您可以选择以下模型：gpt-4o、gpt-4o-mini、gpt-4-turbo、gpt-3.5-turbo 等。更多信息请参见 模型 页面。	gpt-4o-mini
spring.ai.openai.chat.options.temperature	用于控制生成补全结果的表观创造性的采样温度。较高的值会使输出更加随机，而较低的值会使结果更加集中和确定性。不建议在同一补全请求中同时修改 temperature 和 top_p，因为这两个设置的交互作用难以预测。	0.8
spring.ai.openai.chat.options.frequencyPenalty	数值介于 -2.0 到 2.0 之间。正值会根据新 token 在文本中已有的出现频率对其进行惩罚，从而降低模型逐字重复相同内容的可能性。	0.0f
spring.ai.openai.chat.options.logitBias	修改指定标记在补全中出现的概率。	-
spring.ai.openai.chat.options.maxTokens	（已弃用，推荐使用 maxCompletionTokens）在聊天补全中生成的最大 token 数量。输入 token 和生成 token 的总长度受模型上下文长度的限制。	-
spring.ai.openai.chat.options.maxCompletionTokens	生成完成时可以生成的 token 数量的上限，包括可见输出 token 和推理 token。	-
spring.ai.openai.chat.options.n	为每个输入消息生成多少个聊天完成选项。请注意，您将根据所有选项中生成的 token 数量进行计费。将 n 保持为 1 以最小化成本。	1
spring.ai.openai.chat.options.store	是否存储此聊天完成请求的输出以供我们的模型使用	false
spring.ai.openai.chat.options.metadata	开发者定义的标签和值，用于在聊天补全仪表板中过滤补全结果。	空映射
spring.ai.openai.chat.options.output-modalities	你希望模型为此请求生成的输出类型。大多数模型都能够生成文本，这是默认设置。gpt-4o-audio-preview 模型还可以用于生成音频。如果你希望此模型同时生成文本和音频响应，可以使用：text, audio。不支持流式传输。	-
spring.ai.openai.chat.options.output-audio	用于音频生成的音频参数。当请求音频输出时（通过 output-modalities: audio），此参数为必填项。需要使用 gpt-4o-audio-preview 模型，并且不支持流式完成（streaming completions）。	-
spring.ai.openai.chat.options.presencePenalty	介于 -2.0 和 2.0 之间的数值。正值会根据新 token 是否出现在当前文本中对其进行惩罚，从而增加模型讨论新话题的可能性。	-
spring.ai.openai.chat.options.responseFormat.type	兼容 GPT-4o、GPT-4o mini、GPT-4 Turbo 以及所有比 gpt-3.5-turbo-1106 更新的 GPT-3.5 Turbo 模型。JSON_OBJECT 类型启用 JSON 模式，确保模型生成的消息是有效的 JSON。JSON_SCHEMA 类型启用结构化输出，确保模型将匹配您提供的 JSON 模式。JSON_SCHEMA 类型还需要设置 responseFormat.schema 属性。	-
spring.ai.openai.chat.options.responseFormat.name	响应格式模式名称。仅适用于 responseFormat.type=JSON_SCHEMA。	custom_schema
spring.ai.openai.chat.options.responseFormat.schema	响应格式 JSON 模式。仅适用于 responseFormat.type=JSON_SCHEMA。	-
spring.ai.openai.chat.options.responseFormat.strict	响应格式 JSON 模式严格性。仅适用于 responseFormat.type=JSON_SCHEMA。	-
spring.ai.openai.chat.options.seed	此功能处于 Beta 测试阶段。如果指定了此功能，我们的系统将尽最大努力进行确定性采样，这样使用相同种子和参数的重复请求应该会返回相同的结果。	-
spring.ai.openai.chat.options.stop	最多 4 个序列，API 将在生成这些序列后停止生成更多的 token。	-
spring.ai.openai.chat.options.topP	一种替代温度采样的方法是核采样（nucleus sampling），在这种方法中，模型会考虑具有 top_p 概率质量的 token 结果。例如，0.1 意味着只考虑构成前 10% 概率质量的 token。我们通常建议调整这个参数或 temperature 参数，但不要同时调整两者。	-
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.parallel-tool-calls	是否在工具使用期间启用并行函数调用。	true
spring.ai.openai.chat.options.http-headers	要添加到聊天完成请求中的可选 HTTP 头信息。要覆盖 api-key，你需要使用 Authorization 头键，并且你必须在键值前加上 Bearer 前缀。	-
spring.ai.openai.chat.options.proxy-tool-calls	如果为 true，Spring AI 不会在内部处理函数调用，而是将它们代理给客户端。然后由客户端负责处理函数调用，将其分派给适当的函数并返回结果。如果为 false（默认值），Spring AI 将在内部处理函数调用。仅适用于支持函数调用的聊天模型。	false

备注

你可以为 ChatModel 和 EmbeddingModel 实现覆盖通用的 spring.ai.openai.base-url 和 spring.ai.openai.api-key。如果设置了 spring.ai.openai.chat.base-url 和 spring.ai.openai.chat.api-key 属性，它们将优先于通用属性。如果你希望为不同的模型和不同的模型端点使用不同的 OpenAI 账户，这将非常有用。

提示

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

运行时选项

OpenAiChatOptions.java 类提供了模型配置，例如使用的模型、温度（temperature）、频率惩罚（frequency penalty）等。

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .model("gpt-4-o")
            .temperature(0.4)
        .build()
    ));

java

提示

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

函数调用

你可以向 OpenAiChatModel 注册自定义的 Java 函数，并让 OpenAI 模型智能地选择输出一个包含参数的 JSON 对象，以调用一个或多个已注册的函数。这是一种强大的技术，可以将 LLM 的能力与外部工具和 API 连接起来。了解更多关于 OpenAI 函数调用 的信息。

多模态

多模态（Multimodality）指的是模型能够同时理解和处理来自多种来源的信息，包括文本、图像、音频以及其他数据格式。OpenAI 支持文本、视觉和音频输入模态。

愿景

提供视觉多模态支持的 OpenAI 模型包括 gpt-4、gpt-4o 和 gpt-4o-mini。更多信息请参考 Vision 指南。

OpenAI 的 User Message API 可以将一组 base64 编码的图像或图像 URL 与消息结合使用。Spring AI 的 Message 接口通过引入 Media 类型，为多模态 AI 模型提供了支持。该类型包含了消息中媒体附件的数据和详细信息，使用了 Spring 的 org.springframework.util.MimeType 和 org.springframework.core.io.Resource 来处理原始媒体数据。

以下是从 OpenAiChatModelIT.java 中摘录的代码示例，展示了如何使用 gpt-4o 模型将用户文本与图像融合。

var imageResource = new ClassPathResource("/multimodal.test.png");

var userMessage = new UserMessage("Explain what do you see on this picture?",
        new Media(MimeTypeUtils.IMAGE_PNG, this.imageResource));

ChatResponse response = chatModel.call(new Prompt(this.userMessage,
        OpenAiChatOptions.builder().model(OpenAiApi.ChatModel.GPT_4_O.getValue()).build()));

java

提示

从 2024 年 6 月 17 日开始，GPT_4_VISION_PREVIEW 将仅对现有用户继续可用。如果您不是现有用户，请使用 GPT_4_O 或 GPT_4_TURBO 模型。更多详情请参见此处。

或使用 gpt-4o 模型的图像 URL 等效内容：

var userMessage = new UserMessage("Explain what do you see on this picture?",
        new Media(MimeTypeUtils.IMAGE_PNG,
                "https://docs.spring.io/spring-ai/reference/_images/multimodal.test.png"));

ChatResponse response = chatModel.call(new Prompt(this.userMessage,
        OpenAiChatOptions.builder().model(OpenAiApi.ChatModel.GPT_4_O.getValue()).build()));

java

提示

你也可以传递多张图片。

该示例展示了一个以 multimodal.test.png 图像作为输入的模型：

连同短信“解释一下你在这张图片上看到了什么？”，并生成如下响应：

This is an image of a fruit bowl with a simple design. The bowl is made of metal with curved wire edges that
create an open structure, allowing the fruit to be visible from all angles. Inside the bowl, there are two
yellow bananas resting on top of what appears to be a red apple. The bananas are slightly overripe, as
indicated by the brown spots on their peels. The bowl has a metal ring at the top, likely to serve as a handle
for carrying. The bowl is placed on a flat surface with a neutral-colored background that provides a clear
view of the fruit inside.

音频

提供输入音频多模态支持的 OpenAI 模型包括 gpt-4o-audio-preview。有关更多信息，请参阅 Audio 指南。

OpenAI 的 User Message API 可以在消息中嵌入一组 base64 编码的音频文件。Spring AI 的 Message 接口通过引入 Media 类型，支持多模态 AI 模型。该类型包含了消息中媒体附件的数据和详细信息，使用了 Spring 的 org.springframework.util.MimeType 和 org.springframework.core.io.Resource 来处理原始媒体数据。目前，OpenAI 仅支持以下媒体类型：audio/mp3 和 audio/wav。

以下是从 OpenAiChatModelIT.java 摘录的代码示例，展示了如何使用 gpt-4o-audio-preview 模型将用户文本与音频文件融合。

var audioResource = new ClassPathResource("speech1.mp3");

var userMessage = new UserMessage("What is this recording about?",
        List.of(new Media(MimeTypeUtils.parseMimeType("audio/mp3"), audioResource)));

ChatResponse response = chatModel.call(new Prompt(List.of(userMessage),
        OpenAiChatOptions.builder().model(OpenAiApi.ChatModel.GPT_4_O_AUDIO_PREVIEW).build()));

java

提示

你也可以传递多个音频文件。

输出音频

提供输入音频多模态支持的 OpenAI 模型包括 gpt-4o-audio-preview。更多信息请参考 音频 指南。

OpenAI 的 Assystant Message API 可以在消息中包含一个 base64 编码的音频文件列表。Spring AI 的 Message 接口通过引入 Media 类型来支持多模态 AI 模型。该类型包含了消息中媒体附件的数据和详细信息，使用了 Spring 的 org.springframework.util.MimeType 和 org.springframework.core.io.Resource 来处理原始媒体数据。目前，OpenAI 仅支持以下音频类型：audio/mp3 和 audio/wav。

以下是一个代码示例，展示了使用 gpt-4o-audio-preview 模型时，用户文本与音频字节数组的响应：

import openai

# 定义用户输入的文本
user_text = "Hello, how can I assist you today?"

# 定义音频字节数组
audio_byte_array = b'\x00\x01\x02\x03\x04\x05'

# 使用 gpt-4o-audio-preview 模型生成响应
response = openai.ChatCompletion.create(
    model="gpt-4o-audio-preview",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": user_text},
        {"role": "assistant", "content": audio_byte_array}
    ]
)

# 打印生成的响应
print(response)

python

在这个示例中，我们使用了 gpt-4o-audio-preview 模型来处理用户输入的文本和音频字节数组，并生成相应的响应。

var userMessage = new UserMessage("Tell me joke about Spring Framework");

ChatResponse response = chatModel.call(new Prompt(List.of(userMessage),
        OpenAiChatOptions.builder()
            .model(OpenAiApi.ChatModel.GPT_4_O_AUDIO_PREVIEW)
            .outputModalities(List.of("text", "audio"))
            .outputAudio(new AudioParameters(Voice.ALLOY, AudioResponseFormat.WAV))
            .build()));

String text = response.getResult().getOutput().getContent(); // audio transcript

byte[] waveAudio = response.getResult().getOutput().getMedia().get(0).getDataAsByteArray(); // audio data

java

你必须在 OpenAiChatOptions 中指定一个 audio 模态来生成音频输出。AudioParameters 类提供了音频输出的声音和音频格式。

结构化输出

OpenAI 提供了定制的 Structured Outputs API，确保您的模型生成的响应严格符合您提供的 JSON Schema。除了现有的 Spring AI 模型无关的 Structured Output Converter，这些 API 还提供了增强的控制和精确性。

备注

目前，OpenAI 支持 JSON Schema 语言的一个子集 格式。

配置

Spring AI 允许你通过编程方式使用 OpenAiChatOptions 构建器或通过应用程序属性来配置你的响应格式。

使用聊天选项构建器

你可以通过 OpenAiChatOptions 构建器以编程方式设置响应格式，如下所示：

String jsonSchema = """
        {
            "type": "object",
            "properties": {
                "steps": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "explanation": { "type": "string" },
                            "output": { "type": "string" }
                        },
                        "required": ["explanation", "output"],
                        "additionalProperties": false
                    }
                },
                "final_answer": { "type": "string" }
            },
            "required": ["steps", "final_answer"],
            "additionalProperties": false
        }
        """;

Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
        OpenAiChatOptions.builder()
            .model(ChatModel.GPT_4_O_MINI)
            .responseFormat(new ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, this.jsonSchema))
            .build());

ChatResponse response = this.openAiChatModel.call(this.prompt);

java

备注

遵循 OpenAI 的 JSON Schema 语言子集 格式。

与 BeanOutputConverter 工具集成

你可以利用现有的 BeanOutputConverter 工具，自动从你的领域对象生成 JSON Schema，并将结构化响应转换为特定领域的实例：

Java

record MathReasoning(
    @JsonProperty(required = true, value = "steps") Steps steps,
    @JsonProperty(required = true, value = "final_answer") String finalAnswer) {

    record Steps(
        @JsonProperty(required = true, value = "items") Items[] items) {

        record Items(
            @JsonProperty(required = true, value = "explanation") String explanation,
            @JsonProperty(required = true, value = "output") String output) {
        }
    }
}

var outputConverter = new BeanOutputConverter<>(MathReasoning.class);

var jsonSchema = this.outputConverter.getJsonSchema();

Prompt prompt = new Prompt("how can I solve 8x + 7 = -23",
        OpenAiChatOptions.builder()
            .model(ChatModel.GPT_4_O_MINI)
            .responseFormat(new ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, this.jsonSchema))
            .build());

ChatResponse response = this.openAiChatModel.call(this.prompt);
String content = this.response.getResult().getOutput().getContent();

MathReasoning mathReasoning = this.outputConverter.convert(this.content);

java

Kotlin

data class MathReasoning(
	val steps: Steps,
	@get:JsonProperty(value = "final_answer") val finalAnswer: String) {

	data class Steps(val items: Array<Items>) {

		data class Items(
			val explanation: String,
			val output: String)
	}
}

val outputConverter = BeanOutputConverter(MathReasoning::class.java)

val jsonSchema = outputConverter.jsonSchema;

val prompt = Prompt("how can I solve 8x + 7 = -23",
	OpenAiChatOptions.builder()
		.model(ChatModel.GPT_4_O_MINI)
		.responseFormat(ResponseFormat(ResponseFormat.Type.JSON_SCHEMA, jsonSchema))
		.build())

val response = openAiChatModel.call(prompt)
val content = response.getResult().getOutput().getContent()

val mathReasoning = outputConverter.convert(content)

kotlin

备注

虽然这在 JSON Schema 中是可选的，但 OpenAI 要求必须字段以确保结构化响应能够正常工作。Kotlin 反射用于根据类型的可空性和参数的默认值推断哪些属性是必需的，因此在大多数情况下不需要使用 @get:JsonProperty(required = true)。@get:JsonProperty(value = "custom_name") 可以用于自定义属性名称。确保使用 @get: 语法在相关的 getter 上生成注解，参见相关文档。

通过应用属性配置

或者，在使用 OpenAI 自动配置时，你可以通过以下应用程序属性来配置所需的响应格式：

spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.chat.options.model=gpt-4o-mini

spring.ai.openai.chat.options.response-format.type=JSON_SCHEMA
spring.ai.openai.chat.options.response-format.name=MySchemaName
spring.ai.openai.chat.options.response-format.schema={"type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"explanation":{"type":"string"},"output":{"type":"string"}},"required":["explanation","output"],"additionalProperties":false}},"final_answer":{"type":"string"}},"required":["steps","final_answer"],"additionalProperties":false}
spring.ai.openai.chat.options.response-format.strict=true

application.properties

示例控制器

创建一个新的 Spring Boot 项目，并将 spring-ai-openai-spring-boot-starter 添加到你的 pom（或 gradle）依赖中。

在 src/main/resources 目录下添加一个 application.properties 文件，以启用并配置 OpenAi 聊天模型：

spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.chat.options.model=gpt-4o
spring.ai.openai.chat.options.temperature=0.7

application.properties

:::提示
将 api-key 替换为您的 OpenAI 凭证。
:::

这将创建一个 OpenAiChatModel 实现，你可以将其注入到你的类中。以下是一个简单的 @RestController 类的示例，该类使用聊天模型进行文本生成。

@RestController
public class ChatController {

    private final OpenAiChatModel chatModel;

    @Autowired
    public ChatController(OpenAiChatModel chatModel) {
        this.chatModel = chatModel;
    }

    @GetMapping("/ai/generate")
    public Map<String,String> 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);
    }
}

java

手动配置

OpenAiChatModel 实现了 ChatModel 和 StreamingChatModel 接口，并使用 低层级的 OpenAiApi 客户端 来连接到 OpenAI 服务。

将 spring-ai-openai 依赖添加到你的项目的 Maven pom.xml 文件中：

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

xml

或添加到你的 Gradle build.gradle 构建文件中。

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

groovy

:::提示
请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
:::

接下来，创建一个 OpenAiChatModel 并使用它进行文本生成：

var openAiApi = new OpenAiApi(System.getenv("OPENAI_API_KEY"));
var openAiChatOptions = OpenAiChatOptions.builder()
            .model("gpt-3.5-turbo")
            .temperature(0.4)
            .maxTokens(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."));

java

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

低级 OpenAiApi 客户端

OpenAiApi 提供了一个轻量级的 Java 客户端，用于 OpenAI Chat API OpenAI Chat API。

以下类图展示了 OpenAiApi 聊天接口及其构建模块：

以下是一个简单的代码片段，展示了如何以编程方式使用该 API：

# 示例代码
import requests

# 设置 API 端点
api_url = "https://api.example.com/data"

# 发送 GET 请求
response = requests.get(api_url)

# 检查响应状态
if response.status_code == 200:
    data = response.json()
    print("数据获取成功:", data)
else:
    print("请求失败，状态码:", response.status_code)

python

这个示例展示了如何使用 Python 的 requests 库来调用一个 API 并处理响应。

OpenAiApi openAiApi =
    new OpenAiApi(System.getenv("OPENAI_API_KEY"));

ChatCompletionMessage chatCompletionMessage =
    new ChatCompletionMessage("Hello world", Role.USER);

// Sync request
ResponseEntity<ChatCompletion> response = this.openAiApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(this.chatCompletionMessage), "gpt-3.5-turbo", 0.8, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.openAiApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(this.chatCompletionMessage), "gpt-3.5-turbo", 0.8, true));

java

有关更多信息，请参阅 OpenAiApi.java 的 JavaDoc。

低级 API 示例

• OpenAiApiIT.java 测试提供了一些关于如何使用轻量级库的通用示例。

• OpenAiApiToolFunctionCallIT.java 测试展示了如何使用底层 API 调用工具函数。基于 OpenAI 函数调用 教程。

API 密钥管理

Spring AI 通过 ApiKey 接口及其实现提供了灵活的 API 密钥管理。默认实现 SimpleApiKey 适用于大多数用例，但你也可以为更复杂的场景创建自定义实现。

默认配置

默认情况下，Spring Boot 自动配置将使用 spring.ai.openai.api-key 属性创建一个 API key bean：

spring.ai.openai.api-key=your-api-key-here

properties

自定义 API 密钥配置

你可以使用构建器模式创建一个自定义的 OpenAiApi 实例，并使用你自己的 ApiKey 实现：

ApiKey customApiKey = new ApiKey() {
    @Override
    public String getValue() {
        // Custom logic to retrieve API key
        return "your-api-key-here";
    }
};

OpenAiApi openAiApi = OpenAiApi.builder()
    .apiKey(customApiKey)
    .build();

// Create a chat client with the custom OpenAiApi instance
OpenAiChatClient chatClient = new OpenAiChatClient(openAiApi);

java

这在以下情况下非常有用：

• 从安全的密钥存储中检索 API 密钥

• 动态轮换 API 密钥

• 实现自定义的 API 密钥选择逻辑

章节概述

📄️ OpenAI 函数调用（已弃用）

你可以向 OpenAiChatModel 注册自定义的 Java 函数，并让 OpenAI 模型智能地选择输出一个包含参数的 JSON 对象，以调用一个或多个已注册的函数。这使得你可以将 LLM 的能力与外部工具和 API 连接起来。OpenAI 模型经过训练，能够检测何时应该调用函数，并以符合函数签名的 JSON 格式进行响应。