OpenAI 嵌入
Spring AI支持OpenAI的文本嵌入模型。OpenAI的文本嵌入用于衡量文本字符串之间的相关性。嵌入是一个浮点数向量（列表），两个向量之间的距离反映了它们的相关程度：距离越小表示相关性越高，距离越大表示相关性越低。
先决条件
您需要创建一个与OpenAI对接的API来访问OpenAI的嵌入模型。
在OpenAI 注册页面创建一个账户，并在API 密钥页面生成令牌。
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中央仓库和Spring快照仓库。请参阅工件仓库章节，将这些仓库添加到您的构建系统中。
为了帮助管理依赖项，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用统一版本的 Spring AI。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 的自动配置和 starter 模块的 artifact 名称发生了重大变化。更多信息请参阅升级说明。
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 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 | 不应触发重试（例如，抛出 NonTransientAiException）的 HTTP 状态码列表。 | empty |
| spring.ai.retry.on-http-codes | 应触发重试（例如，抛出 TransientAiException）的 HTTP 状态码列表。 | 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 请求使用的项目。 | - |
对于属于多个组织的用户（或通过其遗留用户 API 密钥访问项目的用户），您可以选择指定 API 请求使用哪个组织和项目。这些 API 请求的使用量将计入指定组织和项目的用量中。
配置属性
嵌入模型的自动配置启用与禁用现在通过顶级属性 spring.ai.model.embedding 进行配置。
要启用，设置 spring.ai.model.embedding=openai（默认已启用）
要禁用，设置 spring.ai.model.embedding=none（或任何不匹配 openai 的值）
此项变更是为了支持多模型的配置。
spring.ai.openai.embedding 是用于配置 OpenAI EmbeddingModel 实现的属性前缀。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.openai.embedding.enabled (已失效且必须) | 启用 OpenAI 嵌入模型。 | true |
| spring.ai.model.embedding | 启用 OpenAI 嵌入模型。 | openai |
| spring.ai.openai.embedding.base-url | 可选，覆盖 spring.ai.openai.base-url 以提供嵌入模型特定的 URL | - |
| spring.ai.openai.embedding.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 构造函数来设置所有嵌入请求使用的默认选项。在运行时，您可以通过在 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
这将创建一个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 = 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() 方法，以便轻松创建配置选项。