|
最新快照版本请使用Spring AI 1.1.0！ |
OpenAI 嵌入
Spring AI 支持 OpenAI 的文本嵌入模型。 OpenAI的文本嵌入测量文本字符串的相关性。 嵌入是浮点数的向量（列表）。两个向量之间的距离衡量它们的相关性。距离较小表示高度相关性，较大距离表示高度相关性。
前提条件
你需要用OpenAI创建一个API来访问OpenAI嵌入模型。
在OpenAI注册页面创建账户，并在API密钥页面生成Tokens。
Spring AI 项目定义了一个配置属性，名为spring.ai.openai.api-key（春.ai.openai.api-key）你应该设置为API 密钥资料来源 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");自动配置
|
春季AI自动配置、起始模块的工件名称发生了重大变化。 更多信息请参阅升级说明。 |
Spring AI 为 OpenAI 嵌入模型提供 Spring Boot 自动配置。
要启用它，请在项目的Maven中添加以下依赖pom.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的物料清单添加到你的构建文件中。 |
嵌入性质
重试属性
前缀spring.ai.retry作为属性前缀，允许你配置 OpenAI 嵌入模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
spring.ai.retry.max尝试 |
重试次数上限。 |
10 |
spring.ai.retry.backoff.initial-interval |
指数式退避政策的初始睡眠时长。 |
两秒钟。 |
spring.ai.retry.backoff.multiplier |
后退间隔倍数。 |
5 |
spring.ai.retry.backoff.max区间 |
最大退回时间。 |
3分钟。 |
spring.ai.retry.on-client-errors |
如果为假，抛出非瞬态AiException，且不要尝试重试 |
false |
spring.ai.retry.exclude-on-http-codes |
不应该触发重试的HTTP状态码列表（例如抛出非瞬态Ai异常）。 |
empty |
spring.ai.retry.on-http-codes |
应触发重试的HTTP状态码列表（例如抛出TransientAiException）。 |
empty |
连接性质
前缀春.ai.openai作为属性前缀，允许你连接到OpenAI。
| 属性 | 描述 | 默认值 |
|---|---|---|
Spring.ai.openai.base-url |
连接的URL（链接） |
https://api.openai.com |
spring.ai.openai.api-key（春.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的实现。
| 属性 | 描述 | 默认值 |
|---|---|---|
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 |
附加到基础网址的路径 |
|
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 |
应采用的模型 |
文本嵌入-ada-002（其他选项：文本嵌入-3-大，文本嵌入-3-小） |
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（春.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账户，这非常有用。 |
运行时选项
OpenAiEmbeddingOptions.java提供OpenAI配置，比如使用模型等。
默认选项可以通过以下方式配置spring.ai.openai.embedding.optionss房产也是。
在开始时使用OpenAiEmbeddingModel构建器（constructor）来设置所有嵌入请求的默认选项。
运行时你可以通过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()));采样控制器
这将产生嵌入模型你可以把这些实现注入到你的类里。
这里有一个简单的例子@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 嵌入模型。
为此添加春艾开胃对你项目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的物料清单添加到你的构建文件中。 |
这春艾开胃依赖还提供访问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 和选项类提供了架构商（）方便创建期权。