OpenAI嵌入式

Spring AI支持OpenAI的文本嵌入模型。OpenAI的文本嵌入度量文本字符串之间的相关性。嵌入是一个浮点数向量（列表）。两个向量之间的距离测量它们的相关性。小距离表示高相关性，大距离表示低相关性。

先决条件

您需要创建一个与OpenAI的API来访问OpenAI嵌入模型。

在OpenAI注册页面创建一个帐户，并在API密钥页面生成令牌。Spring AI项目定义了一个名为spring.ai.openai.api-key的配置属性，您应该将其设置为从openai.com获取的API密钥的值。导出环境变量是设置该配置属性的一种方法：

export SPRING_AI_OPENAI_API_KEY=<在此处插入密钥>

添加仓库和BOM

Spring AI工件发布在Spring里程碑和快照仓库中。请参阅仓库部分，将这些仓库添加到您的构建系统中。

为了帮助依赖管理，Spring AI提供了一个BOM（材料清单），以确保整个项目中使用一致的Spring AI版本。请参阅依赖管理部分，将Spring AI BOM添加到您的构建系统中。

自动配置

Spring AI提供了Azure OpenAI嵌入式客户端的Spring Boot自动配置。要启用它，请将以下依赖项添加到项目的Maven pom.xml文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

或者添加到Gradle的build.gradle文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参考依赖项管理部分将Spring AI BOM添加到您的构建文件中。

嵌入属性

重试属性

前缀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）。

空

连接属性

前缀spring.ai.openai用作属性前缀，可让您连接到OpenAI。

配置属性

前缀 spring.ai.openai.embedding 是用于配置 OpenAI 的 EmbeddingClient 实现的属性前缀。

属性 描述 默认值

spring.ai.openai.embedding.enabled

启用 OpenAI 嵌入客户端。

true

spring.ai.openai.embedding.base-url

可选，覆盖 spring.ai.openai.base-url 以提供嵌入特定的 URL

-

spring.ai.openai.embedding.api-key

可选，覆盖 spring.ai.openai.api-key 以提供嵌入特定的 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.base-url 和 spring.ai.openai.api-key 以供 ChatClient 和 EmbeddingClient 实现使用。如果设置了 spring.ai.openai.embedding.base-url 和 spring.ai.openai.embedding.api-key 属性，则优先于常见属性。同样，如果设置了 spring.ai.openai.embedding.base-url 和 spring.ai.openai.embedding.api-key 属性，则优先于常见属性。如果您想为不同的模型和不同的模型端点使用不同的 OpenAI 帐户，则此功能很有用。
所有以 spring.ai.openai.embedding.options 为前缀的属性都可以通过向 EmbeddingRequest 调用添加请求特定的 嵌入选项 来在运行时进行覆盖。

嵌入选项

OpenAiEmbeddingOptions.java 提供了 OpenAI 的配置，例如要使用的模型等。

默认选项也可以使用 spring.ai.openai.embedding.options 属性进行配置。

在启动时，使用 OpenAiEmbeddingClient 构造函数设置用于所有嵌入请求的默认选项。在运行时，您可以使用 OpenAiEmbeddingOptions 实例覆盖默认选项，作为您的 EmbeddingRequest 的一部分。

例如，要为特定请求覆盖默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
        OpenAiEmbeddingOptions.builder()
            .withModel("Different-Embedding-Model-Deployment-Name")
        .build()));

示例控制器（自动配置）

这将创建一个您可以注入到类中的 EmbeddingClient 实现。以下是一个使用 EmbeddingClient 实现的简单 @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 EmbeddingClient embeddingClient;

    @Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

    @GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.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.gradle构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
参考依赖管理部分，将Spring AI BOM添加到您的构建文件中。
spring-ai-openai依赖项还提供对OpenAiChatClient的访问。有关OpenAiChatClient的更多信息，请参阅OpenAI聊天客户端部分。

接下来，创建一个OpenAiEmbeddingClient实例，并使用它计算两个输入文本之间的相似度：

var openAiApi = new OpenAiApi(System.getenv("OPENAI_API_KEY"));

var embeddingClient = new OpenAiEmbeddingClient(openAiApi)
    .withDefaultOptions(OpenAiChatOptions.build()
        .withModel("text-embedding-ada-002")
        .withUser("user-6")
        .build());

EmbeddingResponse embeddingResponse = embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

OpenAiEmbeddingOptions提供了嵌入请求的配置信息。该选项类提供了一个builder()，用于轻松创建选项。