OpenAI 嵌入

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

NOTE

从 2.0.0-M5 版本起，Spring AI 在所有 OpenAI 模型底层使用官方的 openai-java SDK。此次迁移预期是无缝的，OpenAI API 属性与构建器的现有用户不会遇到破坏性变更。如发现任何问题，请在 Spring AI GitHub Issues 向我们报告。

前置条件

你需要在 OpenAI 创建一个 API 才能使用 OpenAI 的嵌入模型。

在 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>

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

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

添加仓库与 BOM

Spring AI 的制品发布在 Maven Central 和 Spring Snapshot 仓库中。 参见 制品仓库 一节，把这些仓库添加到你的构建系统。

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

自动配置

NOTE

Spring AI 的自动配置、starter 模块的制品名称发生了重大变更。 更多信息请参阅 升级说明。

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

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

嵌入属性

重试属性

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

属性	描述	默认值
spring.ai.retry.max-attempts	最大重试尝试次数。	10
spring.ai.retry.backoff.initial-interval	指数退避策略的初始等待时长。	2 sec.
spring.ai.retry.backoff.multiplier	退避间隔乘数。	5
spring.ai.retry.backoff.max-interval	最大退避时长。	3 min.
spring.ai.retry.on-client-errors	若为 false，则抛出 NonTransientAiException，不对 4xx 客户端错误码尝试重试	false
spring.ai.retry.exclude-on-http-codes	不应触发重试的 HTTP 状态码列表（例如抛出 NonTransientAiException）。	empty
spring.ai.retry.on-http-codes	应触发重试的 HTTP 状态码列表（例如抛出 TransientAiException）。	empty

连接属性

前缀 spring.ai.openai 用作连接 OpenAI 的属性前缀。

属性	描述	默认值
spring.ai.openai.base-url	要连接到的 URL	+https://api.openai.com+
spring.ai.openai.api-key	API 密钥	-
spring.ai.openai.organization-id	可选地，你可以指定某组织用于 API 请求。	-
spring.ai.openai.project-id	可选地，你可以指定某项目用于 API 请求。	-
spring.ai.openai.timeout	OpenAI 客户端的请求超时。	60 sec.
spring.ai.openai.max-retries	OpenAI 客户端的最大重试次数。	3
spring.ai.openai.proxy	OpenAI 客户端的代理设置。	-
spring.ai.openai.custom-headers	要添加到 OpenAI 客户端请求的自定义 HTTP 头。	empty
spring.ai.openai.connection-pool-metrics-enabled	是否为底层 OkHttp 客户端启用连接池指标。	false

TIP

对于属于多个组织（或通过旧版用户 API 密钥访问其项目）的用户，可选地，你可以指定哪个组织和项目用于 API 请求。

这些 API 请求的用量将计入所指定组织和项目的用量。

配置属性

NOTE

嵌入自动配置的启用与禁用，现已通过以 spring.ai.model.embedding 为前缀的顶层属性来配置。

要启用，spring.ai.model.embedding=openai（默认启用）

要禁用，spring.ai.model.embedding=none（或任何不匹配 openai 的值）

做出此变更是为了支持配置多个模型。

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

属性	描述	默认值
spring.ai.model.embedding	启用 OpenAI 嵌入模型。	openai
spring.ai.openai.embedding.base-url	可选，覆盖 spring.ai.openai.base-url 以提供嵌入专用的 url	-
spring.ai.openai.embedding.api-key	可选，覆盖 spring.ai.openai.api-key 以提供嵌入专用的 api-key	-
spring.ai.openai.embedding.organization-id	可选地，你可以指定某组织用于 API 请求。	-
spring.ai.openai.embedding.project-id	可选地，你可以指定某项目用于 API 请求。	-
spring.ai.openai.embedding.metadata-mode	文档内容提取模式。	EMBED
spring.ai.openai.embedding.model	要使用的模型	text-embedding-ada-002（其他选项：text-embedding-3-large、text-embedding-3-small）
spring.ai.openai.embedding.encoding-format	返回嵌入所用的格式。可为 float 或 base64。	-
spring.ai.openai.embedding.user	表示你最终用户的唯一标识符，可帮助 OpenAI 监控和检测滥用。	-
spring.ai.openai.embedding.dimensions	所生成输出嵌入应具有的维度数。仅在 text-embedding-3 及之后的模型中受支持。	-
spring.ai.openai.embedding.extra-body	要发送给 OpenAI 兼容服务商的额外 body 属性。	-

NOTE

你可以为 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 账户时，这很有用。

TIP

所有以 spring.ai.openai.embedding 为前缀的属性，都可通过在 EmbeddingRequest 调用中添加一个请求专用的 embedding-options 在运行时被覆盖。

运行时选项

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.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 嵌入模型。 为此，将 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'
}

TIP

参见 依赖管理 一节，把 Spring AI BOM 添加到你的构建文件。

NOTE

spring-ai-openai 依赖同时也提供对 OpenAiChatModel 的访问。

关于 OpenAiChatModel 的更多信息，请参阅 OpenAI 聊天客户端 一节。

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

var embeddingModel = new OpenAiEmbeddingModel(
        MetadataMode.EMBED,
        OpenAiEmbeddingOptions.builder()
                .apiKey(System.getenv("OPENAI_API_KEY"))
                .model("text-embedding-ada-002")
                .user("user-6")
                .build());

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

OpenAiEmbeddingOptions 为嵌入请求提供配置信息。 api 和 options 类提供了一个 builder() 以便轻松创建选项。

定制 HTTP 客户端

Spring AI 在底层使用官方的 openai-java SDK，并通过由 SpringAiOpenAiHttpClient.Builder 构建的自定义 OkHttp 客户端来配置其 HTTP 传输。 你可以通过暴露一个或多个 OpenAiHttpClientBuilderCustomizer bean，在底层 OkHttpClient 创建之前拦截那个构建器。 每个定制器接收的都是每个 OpenAI 模型（聊天、嵌入、图像、音频、审核）所使用的同一个构建器，因此该定制会统一生效。

@FunctionalInterface
public interface OpenAiHttpClientBuilderCustomizer {
    void customize(SpringAiOpenAiHttpClient.Builder builder);
}

典型用例包括：

• 注册 OkHttp 的 Interceptor 实例（身份认证、传播头、自定义日志）；
• 更换调度器的 ExecutorService（例如，把异步 I/O 路由到虚拟线程）；
• 配置代理、SSL、主机名验证，或构建器暴露的连接池大小。

当存在多个定制器时，它们会按 @Order / Ordered 顺序、在 Spring AI 自身默认值之后应用，因此用户代码胜出。

当通过 OpenAi*Model.Builder 手动装配模型时，同样的钩子也可用：

var chatModel = OpenAiChatModel.builder()
    .options(OpenAiChatOptions.builder().model("gpt-4o").build())
    .httpClientBuilderCustomizer(myCustomizer)
    .build();