OpenAI

OpenAI Chat

Spring AI 支持 OpenAI 的 AI 语言模型 ChatGPT。由于创建了行业领先的文本生成模型和嵌入，ChatGPT 在激发人们对人工智能驱动的文本生成的兴趣方面发挥了重要作用。

先决条件

您需要使用 OpenAI 创建 API 来访问 ChatGPT 模型。

在OpenAI 注册页面 创建帐户 并在API 密钥页面生成令牌。 Spring AI 项目定义了一个名为的配置属性，您应该将其设置为从 openai.com 获取的spring.ai.openai.api-key值。

导出环境变量是设置该配置属性的一种方法：

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

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

自动配置

Spring AI 为 OpenAI 聊天客户端提供 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'
}

Chat 属性

重试属性

spring.ai.retry 前缀的属性，可让您配置 OpenAI Chat 客户端的重试机制。

连接属性

spring.ai.openai 前缀的属性，可让您配置 OpenAI Chat 客户端的连接。

配置属性

spring.ai.openai.chat 前缀的属性，可让您配置 OpenAI 的 ChatClient 实现。

注意:

• 你可以覆盖 ChatClient 和 EmbeddingClient 的 通用参数 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 提供模型配置，例如：要使用的模型、温度、频率惩罚等。

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

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

ChatResponse response = chatClient.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        OpenAiChatOptions.builder()
            .withModel("gpt-4-32k")
            .withTemperature(0.4)
        .build()
    ));

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

Function Calling（函数调用）

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

Sample Controller （自动配置）

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

在 src/main/resources目录下添加一个application.properties文件，以启用和配置 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

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

这将创建一个可以注入到您的类中的 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， 并使用 轻量级 Api 连接到 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'
}

接下来, 创建一个 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("Generate the names of 5 famous pirates."));

// Or with streaming responses
Flux<ChatResponse> response = chatClient.stream(
    new Prompt("Generate the names of 5 famous pirates."));

• OpenAiChatOptions 提供聊天请求的配置信息.
• OpenAiChatOptions.Builder 流式的选项生成器.

轻量级 OpenAiApi 客户端

OpenAiApi 为 OpenAI Chat API 提供了轻量级 Java 客户端。

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

以下是如何以编程方式使用 api 的简单片段：

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

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

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

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

请关注 OpenAiApi.java 的 JavaDoc 以获取更多信息。