OpenAI 嵌入
Spring AI 支持 OpenAI 的文本嵌入模型。OpenAI 的文本嵌入用于衡量文本字符串之间的相关性。嵌入是一个浮点数组成的向量（列表）。两个向量之间的距离衡量了它们的相关性。距离小表示相关性高，距离大表示相关性低。
先决条件
你需要创建一个 API 来访问 OpenAI 的嵌入模型。
在 OpenAI 注册页面 创建一个账户，并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，你应该将其设置为从 openai.com 获取的 API Key 的值。导出环境变量是设置该配置属性的一种方式：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>
添加仓库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 仓库 部分，将这些仓库添加到您的构建系统中。
为了帮助进行依赖管理，Spring AI 提供了一个 BOM（物料清单）来确保在整个项目中使用一致版本的 Spring AI。请参考 依赖管理 部分，将 Spring AI BOM 添加到你的构建系统中。
自动配置
Spring AI 为 OpenAI 的 Embedding 模型提供了 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'
}
请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
嵌入属性
重试属性
前缀 spring.ai.retry 用作属性前缀，允许你为 OpenAI Embedding 模型配置重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.retry.max-attempts | 最大重试次数。 | 10 |
| spring.ai.retry.backoff.initial-interval | 指数退避策略的初始睡眠时长。 | 2 秒 |
| spring.ai.retry.backoff.multiplier | 退避间隔乘数。 | 5 |
| spring.ai.retry.backoff.max-interval | 最大退避时长。 | 3 分钟 |
| spring.ai.retry.on-client-errors | 如果为 false，抛出 NonTransientAiException，并且不会为 4xx 客户端错误代码尝试重试 | false |
| spring.ai.retry.exclude-on-http-codes | 不应触发重试的 HTTP 状态码列表（例如抛出 NonTransientAiException）。 | 空 |
| spring.ai.retry.on-http-codes | 应触发重试的 HTTP 状态码列表（例如抛出 TransientAiException）。 | 空 |
连接属性
前缀 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 请求的项目。 | - |
对于属于多个组织（或通过其遗留用户 API 密钥访问其项目）的用户，您可以选择指定 API 请求使用哪个组织和项目。这些 API 请求的使用将计入指定组织和项目的使用量。
配置属性
前缀 spring.ai.openai.embedding 是一个属性前缀，用于配置 OpenAI 的 EmbeddingModel 实现。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.embedding.enabled | 启用 OpenAI 嵌入模型。 | true |
| spring.ai.openai.embedding.base-url | 可选，覆盖 spring.ai.openai.base-url 以提供嵌入特定的 URL。 | - |
| spring.ai.openai.chat.embeddings-path | 附加到 base-url 的路径。 | /v1/embeddings |
| spring.ai.openai.embedding.api-key | 可选，覆盖 spring.ai.openai.api-key 以提供嵌入特定的 API 密钥。 | - |
| 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.options.model | 使用的模型。 | text-embedding-ada-002 (其他选项: text-embedding-3-large, text-embedding-3-small) |
| spring.ai.openai.embedding.options.encodingFormat | 返回嵌入的格式。可以是 float 或 base64。 | - |
| spring.ai.openai.embedding.options.user | 表示最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。 | - |
| spring.ai.openai.embedding.options.dimensions | 结果输出嵌入的维度数。仅在 text-embedding-3 及更高版本的模型中支持。 | - |
你可以为 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 构造函数来设置用于所有嵌入请求的默认选项。在运行时，你可以通过使用 OpenAiEmbeddingOptions 实例作为 EmbeddingRequest 的一部分来覆盖默认选项。
例如，要为特定请求覆盖默认模型名称：
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 Embedding 模型。为此，将 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'
}
请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
spring-ai-openai 依赖也提供了对 OpenAiChatModel 的访问。有关 OpenAiChatModel 的更多信息，请参阅 OpenAI 聊天客户端 部分。
接下来，创建一个 OpenAiEmbeddingModel 实例，并使用它来计算两个输入文本之间的相似度：
var openAiApi = new OpenAiApi(System.getenv("OPENAI_API_KEY"));
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 提供了用于嵌入请求的配置信息。该选项类提供了一个 builder() 方法，以便轻松创建选项。