OpenAI Embeddings

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

前提条件（Prerequisites）

• 你需要使用 OpenAI 创建一个 API 来访问 ChatGPT 模型。
• 在 OpenAI 注册页面创建一个账户，并在 API Keys 页面生成令牌。
• Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你应该将其设置为从 openai.com 获取的 API Key 的值。

可以在 application.properties 文件中设置这个配置属性：

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

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

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

# In your environment or .env file
export OPENAI_API_KEY=<your-openai-api-key>

您还可以在 application 代码中以编程方式设置这个配置属性：

// Retrieve API key from a secure source or environment variable
String apiKey = System.getenv("OPENAI_API_KEY");

添加存储库和 BOM

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

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

自动配置（Auto-configuration）

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'
}

嵌入属性（Embedding Properties）

Retry 属性（Retry Properties）

前缀 spring.ai.retry 用作属性前缀，允许您为 OpenAI 模型配置 retry 机制。

连接属性（Connection Properties）

前缀是 spring.ai.openai 的属性，用于配置 OpenAI 的链接。

配置属性（Configuration Properties）

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

运行时选项（Runtime Options ）

OpenAiEmbeddingOptions.java 提供了嵌入请求的配置信息，并提供了一个构建器来创建这些选项。

默认选项也可以通过配置 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()));

示例控制器（Sample Controller）

创建 一个新的 Spring Boot 项目并将其添加 spring-ai-starter-model-openai 到您的 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

@RestController
public class EmbeddingController {

    private final OpenAiEmbeddingModel embeddingModel;

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

    @GetMapping("/v1/embedding")
    public Map<String, Object> embedding(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("embeddings", embeddingModel.embed(message));
    }

}

手动配置（Manual Configuration）

OpenAiEmbeddingModel 实现了 EmbeddingModel , 并使用轻量级 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'
}

接下来，创建一个 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"));