OpenAI Embeddings

Spring AI 支持 OpenAI 的文本嵌入模型。
OpenAI 的文本嵌入衡量文本字符串的相关性。
一个嵌入是一个浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。距离小表明相关性高，距离大表明相关性低。

先决条件

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

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

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

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

为了帮助进行依赖管理，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'
}

Embedding 属性

重试属性

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

连接属性

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

配置属性

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

注意:

• 你可以覆盖 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 帐户，这非常有用。

提示: 通过向 EmbeddingRequest 调用添加请求特定的嵌入选项，可以在运行时覆盖所有 spring.ai.openai.embedding.options 前缀的属性。

Embedding 选项

OpenAiEmbeddingOptions.java 提供 OpenAI 配置，例如要使用的模型等。

spring.ai.openai.embedding.options 的属性可用作为配置默认选项

在启动时使用 OpenAiEmbeddingClient 构造函数设置用于所有嵌入请求的默认选项。在运行时，您可以使用 OpenAiEmbeddingOptions 实例作为 EmbeddingRequest 的一部分覆盖默认配置.

例如，要覆盖特定请求的默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OpenAiEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

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.embedding.options.model=text-embedding-ada-002

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

这将创建一个可以注入到您的类中的 EmbeddingClient 实现。下面是一个@Controller使用 EmbeddingClient 的简单示例。

@RestController
public class EmbeddingController {

    private final EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

如果您不使用 Spring Boot，则可以手动配置 OpenAI Embedding Client。为此，请将 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'
}

接下来，创建一个 OpenAiEmbeddingClient实例并使用它来计算两个输入文本之间的相似度：

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

var embeddingClient = new OpenAiEmbeddingClient(openAiApi)
    .withDefaultOptions(OpenAiChatOptions.build()
        .withModel("text-embedding-ada-002")
        .withUser("user-6")
        .build());

EmbeddingResponse embeddingResponse = embeddingClient
    .embedForResponse(List.of("Hello World", "World is big and salvation is near"));

• OpenAiEmbeddingOptions 提供嵌入请求的配置信息.
• OpenAiEmbeddingOptions.Builder 流式的选项生成器.