Spring AI 第三讲Embeddings(嵌入式) Model API 第一讲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=<INSERT KEY HERE>

添加资源库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 资源库中。请参阅 "版本库 "部分,将这些版本库添加到您的构建系统中。

为了帮助进行依赖性管理,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 Embedding 客户端的重试机制。

PropertyDescriptionDefault

spring.ai.retry.max-attempts

重试的最大次数。

10

spring.ai.retry.backoff.initial-interval

指数后退策略的初始睡眠时间。

2 sec.

spring.ai.retry.backoff.multiplier

回退间隔倍增器。

5

spring.ai.retry.backoff.max-interval

最大回退持续时间。

3 min.

spring.ai.retry.on-client-errors

如果为假,则抛出 NonTransientAiException 异常,并且不尝试重试 4xx 客户端错误代码

false

spring.ai.retry.exclude-on-http-codes

不应触发重试(例如抛出 NonTransientAiException)的 HTTP 状态代码列表。

empty

spring.ai.retry.on-http-codes

应触发重试(例如抛出 TransientAiException)的 HTTP 状态代码列表。

empty

 连接属性

spring.ai.openai 前缀是用于连接 OpenAI 的属性前缀。

PropertyDescriptionDefault

spring.ai.openai.base-url

要连接的 URL

api.openai.com

spring.ai.openai.api-key

The API Key

-

配置属性

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

PropertyDescriptionDefault

spring.ai.openai.embedding.enabled

启用 OpenAI 嵌入模型。

true

spring.ai.openai.embedding.base-url

可选重载 spring.ai.openai.base-url,以提供特定的嵌入网址

-

spring.ai.openai.embedding.api-key

可选重载 spring.ai.openai.api-key,以提供特定的嵌入式 api-key

-

spring.ai.openai.embedding.metadata-mode

文件内容提取模式。

EMBED

spring.ai.openai.embedding.options.model

使用的模式

text-embedding-ada-002 (other options: 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

输出嵌入结果的维数。仅在文本嵌入-3 及更高版本的模型中支持。

-

您可以为 ChatModel 和 EmbeddingModel 实现覆盖常用的 spring.ai.openai.base-url 和 spring.ai.openai.api-key。如果设置了 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 调用中添加特定于请求的 Runtime Options 来在运行时重写。 

 运行时选项

OpenAiEmbeddingOptions.java 提供 OpenAI 配置,如使用的模型等。

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

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

例如,覆盖特定请求的默认模型名称:

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

示例Controller

这将创建一个 EmbeddingModel 实现,您可以将其注入到您的类中。下面是一个使用 EmbeddingModel 实现的简单 @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 Embedding Client。为此,请在项目的 Maven pom.xml 文件中添加 spring-ai-openai 依赖关系:

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

或 Gradle build.gradle 构建文件。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}

请参阅 "依赖关系管理 "部分,将 Spring AI BOM 添加到构建文件中。

 Spring-ai-openai 依赖关系还提供对 OpenAiChatModel 的访问。有关 OpenAiChatModel 的更多信息,请参阅 OpenAI 聊天客户端部分。

接下来,创建 OpenAiEmbeddingModel 实例,并用它计算两个输入文本之间的相似度:

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

var embeddingModel = new OpenAiEmbeddingModel(
        openAiApi,
        MetadataMode.EMBED,
        OpenAiEmbeddingOptions.builder()
                .withModel("text-embedding-ada-002")
                .withUser("user-6")
                .build(),
        RetryUtils.DEFAULT_RETRY_TEMPLATE);

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

 OpenAiEmbeddingOptions 为嵌入请求提供配置信息。该选项类提供了一个 builder(),便于创建选项。

  • 34
    点赞
  • 16
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值