OpenAI Embeddings
Spring AI 支持 OpenAI 的文本嵌入模型。OpenAI 的文本嵌入衡量文本字符串的相关性。嵌入是浮点数向量(列表)。两个向量之间的距离衡量它们的关联性。小距离表示高度相关,大距离表示低相关。
先决条件
您需要通过 OpenAI 创建一个 API 才能访问 OpenAI 嵌入模型。
在 OpenAI 注册页面 创建一个帐户,并在 API 密钥页面 生成令牌。
Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性,您应该将其设置为从 openai.com 获取的 API 密钥 的值。
您可以在 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");
自动配置
|
Spring AI 自动配置、启动模块的工件名称发生了重大变化。请参阅 升级说明 以获取更多信息。 |
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 嵌入模型的重试机制。
| 财产 | 描述 | 默认值 |
|---|---|---|
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,并且不尝试重试 |
假 |
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.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 |
要附加到基本 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.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 嵌入模型。为此,请将 `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()` 以方便选项创建。