Spring AI 使用 OpenAI 嵌入模型

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

前提条件

你需要创建 OpenAI API 密钥才能访问 OpenAI 嵌入模型。

在 OpenAI 注册页面创建账号，并在 API 密钥页面生成令牌。

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

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

spring.ai.openai.api-key=<your-openai-api-key>

为了在处理 API 密钥等敏感信息时提升安全性，你可以使用 Spring 表达式语言（SpEL）引用环境变量：

# 在 application.yml 文件中
spring:
  ai:
    openai:
      api-key: ${OPENAI_API_KEY}
# 在环境变量或 .env 文件中
export OPENAI_API_KEY=<your-openai-api-key>

你也可以在应用代码中通过编程方式设置该配置：

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

添加仓库和物料清单（BOM）

Spring AI 构件发布在 Maven 中央仓库和 Spring 快照仓库中。参考构件仓库章节，将这些仓库添加到你的构建系统中。

为了简化依赖管理，Spring AI 提供了物料清单（BOM），确保整个项目使用一致版本的 Spring AI。参考依赖管理章节，将 Spring AI BOM 添加到你的构建系统中。

自动配置

Spring AI 自动配置、启动器模块的构件名称发生了重大变更。更多信息请参考升级说明。

Spring AI 为 OpenAI 嵌入模型提供了 Spring Boot 自动配置。如需启用该功能，请在项目的 Maven pom.xml 文件中添加以下依赖：

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

或在 Gradle 的 build.gradle 构建文件中添加：

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

参考依赖管理章节，将 Spring AI BOM 添加到你的构建文件中。

嵌入模型属性

重试属性

以 spring.ai.retry 为前缀的属性，用于配置 OpenAI 嵌入模型的重试机制。

连接属性

以 spring.ai.openai 为前缀的属性，用于配置与 OpenAI 的连接。

对于属于多个组织的用户（或通过旧版用户 API 密钥访问项目的用户），可选择性指定 API 请求使用的组织和项目。这些 API 请求的用量将计入指定组织和项目的用量中。

配置属性

嵌入模型自动配置的启用与禁用，现在通过以 spring.ai.model.embedding 为前缀的顶级属性进行配置。

启用配置：spring.ai.model.embedding=openai（默认已启用）

禁用配置：spring.ai.model.embedding=none（或任何不等于 openai 的值）

该变更用于支持多模型配置。

以 spring.ai.openai.embedding 为前缀的属性，用于配置 OpenAI 的 EmbeddingModel 实现类。

你可以为 ChatModel 和 EmbeddingModel 实现类覆盖通用的 spring.ai.openai.base-url 和 spring.ai.openai.api-key 配置。若设置了 spring.ai.openai.embedding.base-url 和 spring.ai.openai.embedding.api-key，优先级将高于通用属性；同理，spring.ai.openai.chat.base-url 和 spring.ai.openai.chat.api-key 优先级也高于通用属性。当你需要为不同模型、不同模型端点使用不同 OpenAI 账号时，该配置非常实用。

所有以 spring.ai.openai.embedding.options 为前缀的属性，都可以在运行时通过向 EmbeddingRequest 请求添加特定的运行时选项进行覆盖。

运行时选项

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

默认选项也可以通过 spring.ai.openai.embedding.options 属性进行配置。

启动时，可通过 OpenAiEmbeddingModel 构造方法设置所有嵌入请求的默认选项。运行时，你可以在 EmbeddingRequest 中使用 OpenAiEmbeddingOptions 实例覆盖默认选项。

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

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

示例控制器

配置完成后会创建 EmbeddingModel 实现类，你可以将其注入到自定义类中。以下是一个使用 EmbeddingModel 的简单 @Controller 示例。

spring.ai.openai.api-key=YOUR_API_KEY
spring.ai.openai.embedding.options.model=text-embedding-ada-002

@RestController
public class EmbeddingController {

    private final EmbeddingModel embeddingModel;

    @Autowired
    public EmbeddingController(EmbeddingModel embeddingModel) {
        this.embeddingModel = embeddingModel;
    }

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

手动配置

如果你不使用 Spring Boot，可以手动配置 OpenAI 嵌入模型。为此，请在项目的 Maven pom.xml 文件中添加 spring-ai-openai 依赖：

<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 添加到你的构建文件中。

spring-ai-openai 依赖同时提供了 OpenAiChatModel 的访问能力。关于 OpenAiChatModel 的更多信息，参考 OpenAI 聊天客户端章节。

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

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

var embeddingModel = new OpenAiEmbeddingModel(
		this.openAiApi,
        MetadataMode.EMBED,
        OpenAiEmbeddingOptions.builder()
                .model("text-embedding-ada-002")
                .user("user-6")
                .build(),
        RetryUtils.DEFAULT_RETRY_TEMPLATE);

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

OpenAiEmbeddingOptions 提供了嵌入请求的配置信息。API 和选项类提供了 builder() 方法，方便创建配置选项。