OpenAI 聊天

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

​

前提条件

你需要使用 OpenAI 创建一个 API 才能访问 ChatGPT 模型。

在 OpenAI 注册页面 创建一个帐户，并在 API 密钥页面 生成令牌。

Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你应该将其设置为从 openai.com 获取的 API 密钥 的值。

你可以在 application.properties 文件中设置此配置属性：

spring.ai.openai.api-key=<你的-openai-api-密钥>

为了在处理 API 密钥等敏感信息时增强安全性，你可以使用 Spring 表达式语言 (SpEL) 来引用自定义环境变量：

# 在 application.yml 中
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}

# 在你的环境或 .env 文件中
export OPENAI_API_KEY=<你的-openai-api-密钥>

你也可以在应用程序代码中以编程方式设置此配置：

// 从安全来源或环境变量中检索 API 密钥
String apiKey = System.getenv("OPENAI_API_KEY");

​

添加仓库和 BOM

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

为了帮助进行依赖管理，Spring AI 提供了一个 BOM (bill of materials)，以确保在整个项目中使用一致版本的 Spring AI。请参阅依赖管理部分，将 Spring AI BOM 添加到你的构建系统中。

​

自动配置

Spring AI 为 OpenAI 聊天客户端提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的构建文件中：

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

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

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

​

配置属性

:::note 聊天自动配置的启用和禁用现在通过前缀为 spring.ai.model.chat 的顶级属性进行配置。

要启用，spring.ai.model.chat=openai (默认启用)

要禁用，spring.ai.model.chat=none (或任何与 openai 不匹配的值)

此更改是为了允许配置多个模型。 :::

​

连接属性

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

:::tip 对于属于多个组织的用户（或通过其旧版用户 API 密钥访问其项目的用户），你可以选择指定用于 API 请求的组织和项目。 来自这些 API 请求的使用量将计为指定组织和项目的使用量。 :::

​

聊天属性

前缀 spring.ai.openai.chat 是属性前缀，允许你配置 OpenAI 的聊天模型实现。

:::note 你可以为 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 帐户，这将非常有用。 :::

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

​

运行时选项

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

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

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

ChatResponse response = chatModel.call(
    new Prompt(
        "生成 5 个著名海盗的名字。",
        OpenAiChatOptions.builder()
            .model("gpt-4o")
            .temperature(0.4)
        .build()
    ));

​

低级 OpenAiApi 客户端

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

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

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

OpenAiApi openAiApi = OpenAiApi.builder()
            .apiKey(System.getenv("OPENAI_API_KEY"))
            .build();

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

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

// 流式请求