OpenAI 嵌入
Spring AI 支持 OpenAI 的文本嵌入模型。OpenAI 的文本嵌入衡量文本字符串的相关性。嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。小距离表示高相关性，大距离表示低相关性。
前提条件
您需要使用 OpenAI 创建 API 才能访问 OpenAI 嵌入模型。
在 OpenAI 注册页面创建一个帐户，并在 API 密钥页面上生成Tokens。
Spring AI 项目定义了一个名为spring.ai.openai.api-key您应该将API Key获得于 openai.com。
您可以在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 Central 和 Spring Snapshot 存储库中。 请参阅 Artifact Repositories 部分，将这些存储库添加到您的构建系统中。
为了帮助进行依赖管理，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。
自动配置
|
Spring AI 自动配置、入门模块的工件名称发生了重大变化。有关更多信息，请参阅升级说明。 |
Spring AI 为 OpenAI 嵌入模型提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>或 Gradlebuild.gradle构建文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}| 请参阅依赖项管理部分，将 Spring AI BOM 添加到构建文件中。 |
嵌入属性
重试属性
前缀spring.ai.retry用作属性前缀，用于配置 OpenAI Embedding 模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.retry.max次尝试 |
重试尝试的最大次数。 |
10 |
spring.ai.retry.backoff.初始间隔 |
指数退避策略的初始睡眠持续时间。 |
2 秒。 |
spring.ai.retry.backoff.乘数 |
回退间隔乘数。 |
5 |
spring.ai.retry.backoff.max间隔 |
最大回退持续时间。 |
3分钟 |
spring.ai.retry.on-client-错误 |
如果为 false，则引发 NonTransientAiException，并且不要尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应触发重试的 HTTP 状态代码列表（例如，引发 NonTransientAiException）。 |
empty |
spring.ai.retry.on-http-代码 |
应触发重试的 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.组织 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是配置EmbeddingModelOpenAI 的实施。
| 属性 | 描述 | 默认值 |
|---|---|---|
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 的路径 |
|
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 |
文档内容提取模式。 |
嵌入 |
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属性也是如此。
在开始时使用OpenAiEmbeddingModelconstructor 来设置用于所有嵌入请求的默认选项。
在运行时，您可以使用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()));Samples控制器
这将创建一个EmbeddingModel您可以注入到类中的实现。这是一个简单的示例@Controller使用EmbeddingModel实现。
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>或 Gradlebuild.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()以便于创建期权。