OpenAI 聊天

Spring AI 支持 OpenAI 的 AI 语言模型 ChatGPT。ChatGPT 在激发人们对基于 AI 的文本生成的兴趣方面发挥了重要作用，这要归功于其创建了业界领先的文本生成模型和嵌入。

先决条件

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

export SPRING_AI_OPENAI_API_KEY=<在此处插入密钥>

添加存储库和 BOM

Spring AI 的构件发布在 Spring Milestone 和 Snapshot 存储库中。请参考 存储库 部分，将这些存储库添加到您的构建系统中。

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

### 自动配置 Auto-configuration

Spring AI为OpenAI Chat Client提供Spring Boot自动配置。要启用它，请向您项目的Maven pom.xml文件中添加以下依赖项：

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参考依赖管理部分，将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.openai 用作属性前缀，用于连接到 OpenAI。

属性 描述 默认值

spring.ai.openai.base-url

要连接的 URL

api.openai.com

spring.ai.openai.api-key

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.api-key

可选，覆盖 spring.ai.openai.api-key 以提供特定于聊天的 API 密钥。

-

spring.ai.openai.chat.options.model

要使用的 OpenAI 聊天模型。

gpt-3.5-turbo（gpt-3.5-turbo、gpt-4 和 gpt-4-32k 指向最新的模型版本）

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.logitBias

修改指定标记出现在完成中的可能性。

-

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

此功能处于 Beta 版。如果指定了，我们的系统将尽最大努力进行确定性抽样，使具有相同种子和参数的重复请求应返回相同的结果。

-

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.base-url和spring.ai.openai.api-key以用于ChatClient和EmbeddingClient的实现。如果设置了spring.ai.openai.chat.base-url和spring.ai.openai.chat.api-key属性，则这些属性优先于通用属性。如果您希望为不同的模型和不同的模型端点使用不同的OpenAI帐户，则此功能非常有用。
所有以spring.ai.openai.chat.options为前缀的属性可以通过向Prompt调用添加一个特定于请求的Chat Options来在运行时进行覆盖。

聊天选项

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

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

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

ChatResponse response = chatClient.call(
    new Prompt(
        "生成5个著名海盗的名字。",
        OpenAiChatOptions.builder()
            .withModel("gpt-4-32k")
            .withTemperature(0.4)
        .build()
    ));
除了特定于模型的 OpenAiChatOptions，您还可以使用可移植的 ChatOptions 实例，使用 ChatOptionsBuilder#builder() 创建。

函数调用

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

示例控制器（自动配置）

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

添加一个 application.properties 文件，放在 src/main/resources 目录下，以启用并配置 OpenAi Chat 客户端：

spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.chat.options.model=gpt-3.5-turbo
spring.ai.openai.chat.options.temperature=0.7
用您的 OpenAI 凭据替换 api-key。

这将创建一个可以注入到您的类中的 OpenAiChatClient 实现。以下是一个使用聊天客户端生成文本的简单 @Controller 类示例。

@RestController
public class ChatController {

    private final OpenAiChatClient chatClient;

    @Autowired
    public ChatController(OpenAiChatClient chatClient) {
        this.chatClient = chatClient;
    }

    @GetMapping("/ai/generate")
    public Map generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("generation", chatClient.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 chatClient.stream(prompt);
    }
}

手动配置

OpenAiChatClient 实现了 ChatClient 和 StreamingChatClient 接口，并使用 低级 OpenAiApi 客户端 连接到 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 添加到您的构建文件中。

接下来，创建一个 OpenAiChatClient 并将其用于文本生成：

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

var chatClient = new OpenAiChatClient(openAiApi)
    .withDefaultOptions(OpenAiChatOptions.builder()
            .withModel("gpt-35-turbo")
            .withTemperature(0.4)
            .withMaxTokens(200)
        .build());

ChatResponse response = chatClient.call(
    new Prompt("生成 5 位著名海盗的名字。"));

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

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

低级 OpenAiApi 客户端

OpenAiApi 提供了轻量级的 Java 客户端，用于 OpenAI 聊天 API OpenAI 聊天 API。

以下类图说明了 OpenAiApi 的聊天接口和构建模块：

OpenAiApi 聊天 API 图表

这是一个简单的代码片段，演示如何在程序中使用该 API：

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

ChatCompletionMessage chatCompletionMessage =
    new ChatCompletionMessage("你好，世界", Role.USER);

// 同步请求
ResponseEntity<ChatCompletion> response = openAiApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(chatCompletionMessage), "gpt-3.5-turbo", 0.8f, false));

// 流式请求
Flux<ChatCompletionChunk> streamResponse = openAiApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(chatCompletionMessage), "gpt-3.5-turbo", 0.8f, true));

请查看 OpenAiApi.java 的 JavaDoc 获取更多信息。

示例代码