OpenAI 嵌入

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

先决条件

您需要使用 OpenAI 创建 API 才能访问 OpenAI 嵌入模型。spring-doc.cn

在 OpenAI 注册页面创建一个帐户，并在 API 密钥页面上生成令牌。 Spring AI 项目定义了一个名为 的配置属性，您应该将其设置为从 openai.com 获取的值。 导出环境变量是设置该配置属性的一种方法：spring.ai.openai.api-keyAPI Keyspring-doc.cn

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

添加存储库和 BOM

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

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

自动配置

Spring AI 为 Azure OpenAI 嵌入模型提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 文件中：pom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

嵌入属性

重试属性

前缀用作属性前缀，允许您为 OpenAI 嵌入模型配置重试机制。spring.ai.retryspring-doc.cn

财产 描述 违约

spring.ai.retry.max 次尝试spring-doc.cn

最大重试尝试次数。spring-doc.cn

10spring-doc.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cn

指数回退策略的初始休眠持续时间。spring-doc.cn

2 秒spring-doc.cn

spring.ai.retry.backoff.multiplierspring-doc.cn

Backoff interval 乘数。spring-doc.cn

5spring-doc.cn

spring.ai.retry.backoff.max 间隔spring-doc.cn

最大回退持续时间。spring-doc.cn

3 分钟spring-doc.cn

spring.ai.retry.on-client-errorsspring-doc.cn

如果为 false，则引发 NonTransientAiException，并且不要尝试重试客户端错误代码4xxspring-doc.cn

假spring-doc.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cn

不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。spring-doc.cn

空spring-doc.cn

spring.ai.retry.on-http-codesspring-doc.cn

应触发重试的 HTTP 状态代码列表（例如，引发 TransientAiException）。spring-doc.cn

空spring-doc.cn

连接属性

前缀用作允许您连接到 OpenAI 的属性前缀。spring.ai.openaispring-doc.cn

财产 描述 违约

spring.ai.openai.base-urlspring-doc.cn

要连接到的 URLspring-doc.cn

https://api.openai.comspring-doc.cn

spring.ai.openai.api-keyspring-doc.cn

API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.openai.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

-spring-doc.cn
对于属于多个组织（或通过其旧版用户 API 密钥访问其项目）的用户，您可以选择指定用于 API 请求的组织和项目。 这些 API 请求的使用量将计为指定组织和项目的使用量。

配置属性

前缀是 property prefix ，用于配置 OpenAI 的实现。spring.ai.openai.embeddingEmbeddingModelspring-doc.cn

财产 描述 违约

spring.ai.openai.embedding.enabledspring-doc.cn

启用 OpenAI 嵌入模型。spring-doc.cn

真spring-doc.cn

spring.ai.openai.embedding.base-urlspring-doc.cn

可选覆盖spring.ai.openai.base-url以提供嵌入特定的 urlspring-doc.cn

-spring-doc.cn

spring.ai.openai.chat.embeddings-路径spring-doc.cn

要附加到 base-url 的路径spring-doc.cn

/v1/embeddingsspring-doc.cn

spring.ai.openai.embedding.api-keyspring-doc.cn

Optional 覆盖 spring.ai.openai.api-key 以提供嵌入特定的 api-keyspring-doc.cn

-spring-doc.cn

spring.ai.openai.embedding.organization-idspring-doc.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cn

-spring-doc.cn

spring.ai.openai.embedding.project-idspring-doc.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cn

-spring-doc.cn

spring.ai.openai.embedding.metadata-modespring-doc.cn

文档内容提取模式。spring-doc.cn

嵌入spring-doc.cn

spring.ai.openai.embedding.options.modelspring-doc.cn

要使用的模型spring-doc.cn

text-embedding-ada-002（其他选项：text-embedding-3-large、text-embedding-3-small）spring-doc.cn

spring.ai.openai.embedding.options.encodingFormatspring-doc.cn

要返回嵌入向量的格式。可以是 float 或 base64。spring-doc.cn

-spring-doc.cn

spring.ai.openai.embedding.options.userspring-doc.cn

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。spring-doc.cn

-spring-doc.cn

spring.ai.openai.embedding.options.dimensionsspring-doc.cn

生成的输出嵌入应具有的维度数。仅在 及更高版本的型号中受支持。text-embedding-3spring-doc.cn

-spring-doc.cn
您可以覆盖 common 和 for the 和 implementations. 如果设置了 and 属性，则优先于公共属性。 同样，如果设置了 and，则优先于通用属性。 如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。spring.ai.openai.base-urlspring.ai.openai.api-keyChatModelEmbeddingModelspring.ai.openai.embedding.base-urlspring.ai.openai.embedding.api-keyspring.ai.openai.chat.base-urlspring.ai.openai.chat.api-key
通过向调用添加特定于请求的运行时选项，可以在运行时覆盖所有前缀为 的属性。spring.ai.openai.embedding.optionsEmbeddingRequest

运行时选项

OpenAiEmbeddingOptions.java 提供了 OpenAI 的配置，例如要使用的模型等。spring-doc.cn

也可以使用 properties 配置默认选项。spring.ai.openai.embedding.optionsspring-doc.cn

在启动时，使用构造函数设置用于所有嵌入请求的默认选项。 在运行时，您可以覆盖默认选项，将实例用作 .OpenAiEmbeddingModelOpenAiEmbeddingOptionsEmbeddingRequestspring-doc.cn

例如，要覆盖特定请求的默认模型名称：spring-doc.cn

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

Samples控制器

这将创建一个可以注入到类中的实现。 下面是一个使用该实现的简单类的示例。EmbeddingModel@ControllerEmbeddingModelspring-doc.cn

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 文件中：spring-ai-openaipom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。
依赖项还提供对 . 有关更多信息，请参阅 OpenAI 聊天客户端 部分。spring-ai-openaiOpenAiChatModelOpenAiChatModel

接下来，创建一个实例并使用它来计算两个输入文本之间的相似性：OpenAiEmbeddingModelspring-doc.cn

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

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

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

这提供了嵌入请求的配置信息。 options 类提供了一个用于轻松创建选项的工具。OpenAiEmbeddingOptionsbuilder()spring-doc.cn