Spring AI支持OpenAI的文本嵌入模型。OpenAI的文本嵌入用于衡量文本字符串之间的相关性。嵌入是一个由浮点数组成的向量(列表)。两个向量之间的距离衡量了它们之间的相关性。距离较小表明相关性较高,距离较大则表明相关性较低。
前提条件
您需要使用OpenAI创建一个API,以便访问OpenAI的嵌入模型。
在OpenAI的注册页面创建一个账户,并在API密钥页面生成令牌。
Spring AI项目定义了一个名为spring.ai.openai.api-key的配置属性,您应将其设置为从openai.com获取的API密钥的值。
您可以在application.properties文件中设置此配置属性:
spring.ai.openai.api-key=<your-openai-api-key>
为了在处理API密钥等敏感信息时增强安全性,您可以使用Spring表达式语言(SpEL)来引用环境变量:
# In application.ymlspring: ai: openai: api-key: ${OPENAI_API_KEY}
# In your environment or .env fileexport OPENAI_API_KEY=<your-openai-api-key>
您还可以在应用程序代码中以编程方式设置此配置:
// Retrieve API key from a secure source or environment variableString apiKey = System.getenv("OPENAI_API_KEY");
添加仓库和BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参阅“构建仓库”部分,以将这些仓库添加到您的构建系统中。
为了辅助依赖管理,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-starter-model-openai</artifactId></dependency>
或者添加到你的 Gradle build.gradle 构建文件中。
dependencies { implementation 'org.springframework.ai:spring-ai-starter-model-openai'}
嵌入属性
重试属性
前缀“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)。 | 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”的顶级属性来配置的。
要启用,请将 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嵌入模型。 | openai |
spring.ai.openai.embedding.base-url | 可选,覆盖spring.ai.openai.base-url以提供嵌入特定url | - |
spring.ai.openai.embedding.embeddings-path | 要附加到基本URL的路径 | /v1/embeddings
|
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 | 文档内容提取模式。 | 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 | 结果输出嵌入应该具有的维数。仅支持 text-embedding-3及更高型号。
| - |
运行时选项
OpenAiEmbeddingOptions提供了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类的示例。
这将创建一个EmbeddingModel实现,你可以将其注入到你的类中。以下是一个使用EmbeddingModel实现的简单@Controller类的示例。
spring.ai.openai.api-key=YOUR_API_KEYspring.ai.openai.embedding.options.model=text-embedding-ada-002
@RestControllerpublic 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'}
接下来,创建一个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()方法,便于创建选项。