|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
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");Auto-configuration
|
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 嵌入模型的重试机制。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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 min. |
spring.ai.retry.on-client-errors |
如果为假，则抛出一个NonTransientAiException，并且不尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应当触发重试的HTTP状态码列表（例如，抛出NonTransientAiException）。 |
<p>空内容</p> |
spring.ai.retry.on-http-codes |
应触发重试的HTTP状态码列表（例如，抛出TransientAiException）。 |
<p>空内容</p> |
连接属性
使用前缀spring.ai.openai作为属性前缀，以便连接到OpenAI。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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 请求的使用量将计入指定的组织和项目。 |
配置属性
|
嵌入自动配置的启用和禁用现在通过前缀为 要启用，请设置 spring.ai.model.embedding=openai（默认已启用） 要禁用，请设置 spring.ai.model.embedding=none（或任何不与 openai 匹配的值） 此更改是为了允许配置多个模型。 |
前缀 spring.ai.openai.embedding 是用于配置 OpenAI 的 EmbeddingModel 实现的属性前缀。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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 密钥 |
- |
spring.ai.openai.embedding.organization-id |
您可以选择指定用于 API 请求的组织。 |
- |
spring.ai.openai.embedding.project-id |
（可选）您可以指定用于 API 请求的项目。 |
- |
spring.ai.openai.embedding.metadata-mode |
文档内容提取模式。 |
嵌入 |
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 |
结果输出嵌入应具备的维度数量。仅在 |
- |
您可以为 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()));样本控制器
这将创建一个您可以注入到类中的 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 和 options 类提供了一个 builder()，以便轻松创建选项。