OpenAI 嵌入
Spring AI 支持 OpenAI 的文本嵌入模型。 OpenAI 的文本嵌入用于衡量文本字符串之间的相关性。 嵌入是一个浮点数的向量（列表）。两个向量之间的距离度量了它们的相关性。距离小表示高度相关，距离大则表示低相关性。
前提条件
您需要创建一个OpenAI API，以便访问OpenAI嵌入模型。
在OpenAI注册页面创建一个帐户，并在API密钥页面生成Tokens。
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");自动配置
|
There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。 |
Spring AI 为 OpenAI 嵌入模型提供了 Spring Boot 自动配置功能。要启用它，请在项目的 Maven pom.xml 文件中添加以下依赖项:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>或者添加到您的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，且不重试客户端错误代码 |
false |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的HTTP状态代码列表（例如，用于抛出非暂时性AI异常）。 |
empty |
spring.ai.retry.on-http-codes |
应触发重试的HTTP状态码列表（例如，用于抛出TransientAiException）。 |
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=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嵌入模型。 |
开源人工智能 |
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 密钥 |
- |
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 |
生成的输出嵌入应具有的维度数量。仅在 |
- |
您可以覆盖通用的 spring.ai.openai.base-url 和 spring.ai.openai.api-key，以便为 ChatModel 和 EmbeddingModel 实现定义。
如果设置了 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依赖项添加到项目Mavenpom.xml文件中:
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或者添加到您的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()，以便于创建选项。