Spring AI支持OpenAI的文本嵌入模型。OpenAI的文本嵌入用于衡量文本字符串的相关性。嵌入是一个由浮点数组成的向量（列表）。两个向量之间的距离用于衡量它们的相关性。距离小表明高度相关，距离大表明相关性低。
先决条件
您需要创建一个与OpenAI的API，以访问OpenAI嵌入模型。
在https://platform.openai.com/signup[OpenAI注册页面]创建一个账户，并在https://platform.openai.com/account/api-keys[API密钥页面]生成令牌。Spring AI项目定义了一个名为`spring.ai.openai.api-key`的配置属性，您应该将其设置为从openai.com获得的`API密钥`的值。导出环境变量是设置该配置属性的一种方式：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>自动配置
Spring AI为Azure OpenAI嵌入式客户端提供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'
}|
Tip
|
请参考依赖管理部分，以将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，并且对`4xx`客户端错误码不尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的HTTP状态码列表（例如，抛出NonTransientAiException）。 |
连接属性
前缀 spring.ai.openai 被用作属性前缀，允许你连接到OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.openai.base-url |
连接的URL |
|
spring.ai.openai.api-key |
API密钥 |
- |
配置属性
前缀 spring.ai.openai.embedding 是配置 OpenAI 的 EmbeddingClient 实现的属性前缀。
属性 |
描述 |
默认值 |
--- |
--- |
|
--- |
spring.ai.openai.embedding.enabled |
|
启用OpenAI嵌入式客户端。 |
true |
|
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.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监控和检测滥用。 |
- |
|
Note
|
您可以覆盖`ChatClient`和`EmbeddingClient`实现的通用`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.embedding.base-url`和`spring.ai.openai.embedding.api-key`属性，它们也将优先于通用属性。如果您希望针对不同的OpenAI账户使用不同的模型和不同的模型端点，这会很有用。 |
|
Tip
|
所有以 spring.ai.openai.embedding.options 为前缀的属性都可以在运行时被覆盖，方法是在 EmbeddingRequest 调用中添加一个特定请求的 [embedding-options]。
|
运行时选项
The OpenAiEmbeddingOptions.java 提供了 OpenAI 的配置，例如要使用的模型等。
默认的选项可以使用 spring.ai.openai.embedding.options 属性进行配置。
在启动时使用`OpenAiEmbeddingClient`构造函数来设置用于所有嵌入请求的默认选项。在运行时，你可以使用一个`OpenAiEmbeddingOptions`实例作为`EmbeddingRequest`的一部分来覆盖默认选项。
例如，要覆盖特定请求的默认模型名称：
EmbeddingResponse embeddingResponse = embeddingClient.call(
new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
OpenAiEmbeddingOptions.builder()
.withModel("Different-Embedding-Model-Deployment-Name")
.build()));样本控制器
这将创建一个`EmbeddingClient`实现，您可以将其注入到您的类中。这里有一个使用`EmbeddingClient`实现的简单`@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 EmbeddingClient embeddingClient;
@Autowired
public EmbeddingController(EmbeddingClient embeddingClient) {
this.embeddingClient = embeddingClient;
}
java
@GetMapping("/ai/embedding")
public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
EmbeddingResponse embeddingResponse = this.embeddingClient.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` 依赖也提供了对 OpenAiChatClient 的访问。有关 OpenAiChatClient 的更多信息，请参考链接：../chat/openai-chat.html[OpenAI Chat Client] 部分。
|
接下来，创建一个`OpenAiEmbeddingClient`实例并使用它来计算两个输入文本之间的相似度：
var openAiApi = new OpenAiApi(System.getenv("OPENAI_API_KEY"));
var embeddingClient = new OpenAiEmbeddingClient(openAiApi)
.withDefaultOptions(OpenAiChatOptions.build()
.withModel("text-embedding-ada-002")
.withUser("user-6")
.build());
EmbeddingResponse embeddingResponse = embeddingClient
.embedForResponse(List.of("Hello World", "World is big and salvation is near"));OpenAiEmbeddingOptions` 提供了嵌入请求的配置信息。选项类提供了一个 builder()，用于简易的选项创建。