|
此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！ |
OpenAI 嵌入
Spring AI 支持 OpenAI 的文本嵌入模型。 OpenAI 的文本嵌入测量文本字符串的相关性。 嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。小距离表示高相关性，大距离表示低相关性。
先决条件
您需要使用 OpenAI 创建 API 才能访问 OpenAI 嵌入模型。
在 OpenAI 注册页面创建一个帐户，并在 API 密钥页面上生成令牌。
Spring AI 项目定义了一个名为spring.ai.openai.api-key，您应该设置为API Key从 openai.com 获得。
导出环境变量是设置该配置属性的一种方法：
export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>添加存储库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 存储库中。 请参阅 Repositories 部分，将这些存储库添加到您的构建系统中。
为了帮助进行依赖项管理，Spring AI 提供了一个 BOM（物料清单），以确保在整个项目中使用一致的 Spring AI 版本。请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 OpenAI 嵌入模型提供 Spring Boot 自动配置。
要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
嵌入属性
重试属性
前缀spring.ai.retry用作属性前缀，用于配置 OpenAI 嵌入模型的重试机制。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.retry.max 次尝试 |
最大重试尝试次数。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数回退策略的初始休眠持续时间。 |
2 秒 |
spring.ai.retry.backoff.multiplier |
Backoff interval 乘数。 |
5 |
spring.ai.retry.backoff.max 间隔 |
最大回退持续时间。 |
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.openai.embedding是属性前缀，该前缀配置EmbeddingModelOpenAI 的实现。
| 财产 | 描述 | 违约 |
|---|---|---|
spring.ai.openai.embedding.enabled |
启用 OpenAI 嵌入模型。 |
真 |
spring.ai.openai.embedding.base-url |
可选覆盖spring.ai.openai.base-url以提供嵌入特定的 url |
- |
spring.ai.openai.chat.embeddings-路径 |
要附加到 base-url 的路径 |
|
spring.ai.openai.embedding.api-key |
Optional 覆盖 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如果设置了 properties，则优先于 common properties。
同样，spring.ai.openai.chat.base-url和spring.ai.openai.chat.api-key如果设置了 properties，则优先于 common properties。
如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。 |
所有前缀为spring.ai.openai.embedding.options可以通过将特定于请求的运行时选项添加到EmbeddingRequest叫。 |
运行时选项
OpenAiEmbeddingOptions.java 提供了 OpenAI 的配置，例如要使用的模型等。
默认选项可以使用spring.ai.openai.embedding.optionsproperties 也是如此。
启动时，使用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依赖项添加到项目的 Mavenpom.xml文件：
<dependency>
<groupId>org.springframework.ai</groupId>
<artifactId>spring-ai-openai</artifactId>
</dependency>或发送到您的 Gradlebuild.gradlebuild 文件。
dependencies {
implementation 'org.springframework.ai:spring-ai-openai'
}| 请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。 |
这spring-ai-openaidependency 还提供对OpenAiChatModel.
有关OpenAiChatModel请参阅 OpenAI Chat 客户端部分。 |
接下来，创建一个OpenAiEmbeddingModel实例，并使用它来计算两个输入文本之间的相似性：
var openAiApi = new OpenAiApi(System.getenv("OPENAI_API_KEY"));
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提供嵌入请求的配置信息。
options 类提供了一个builder()轻松创建选项。