5.3 Spring AI PostgresML 嵌入模型

Spring AI PostgresML 嵌入模型

前言

Spring AI 支持 PostgresML 文本嵌入模型。

嵌入是文本的数值表示。它们用于将单词和句子表示为向量，即数字数组。嵌入可用于查找相似的文本片段，通过使用距离测量比较数值向量的相似性，或者它们可以用作其他机器学习模型的输入特征，因为大多数算法无法直接使用文本。

许多预训练的 LLM 可以在 PostgresML 内用于从文本生成嵌入。您可以浏览所有可用的模型，在 Hugging Face 上找到最佳解决方案。

添加仓库和 BOM

Spring AI 构件发布在 Maven Central 和 Spring Snapshot 仓库中。参考构件仓库部分，将这些仓库添加到您的构建系统中。

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

自动配置

注意 Spring AI 自动配置、启动器模块的构件名称发生了重大变化。请参考升级说明了解更多信息。

Spring AI 为 PostgresML 嵌入模型提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到您项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-postgresml-embedding</artifactId>
</dependency>

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-postgresml-embedding'
}

提示 参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

使用 spring.ai.postgresml.embedding.options.* 属性来配置您的 PostgresMlEmbeddingModel。

嵌入属性

注意 嵌入自动配置的启用和禁用现在通过前缀为 spring.ai.model.embedding 的顶级属性配置。

要启用，设置 spring.ai.model.embedding=postgresml（默认启用）

要禁用，设置 spring.ai.model.embedding=none（或任何不匹配 postgresml 的值）

进行此更改是为了允许配置多个模型。

前缀 spring.ai.postgresml.embedding 是配置 PostgresML 嵌入的 EmbeddingModel 实现的属性前缀。

属性	描述	默认值
spring.ai.postgresml.embedding.enabled (已移除，不再有效)	启用 PostgresML 嵌入模型。	true
spring.ai.model.embedding	启用 PostgresML 嵌入模型。	postgresml
spring.ai.postgresml.embedding.create-extension	执行 SQL 'CREATE EXTENSION IF NOT EXISTS pgml' 来启用扩展	false
spring.ai.postgresml.embedding.options.transformer	用于嵌入的 Hugging Face transformer 模型。	distilbert-base-uncased
spring.ai.postgresml.embedding.options.kwargs	额外的 transformer 特定选项。	empty map
spring.ai.postgresml.embedding.options.vectorType	用于嵌入的 PostgresML 向量类型。支持两个选项：PG_ARRAY 和 PG_VECTOR。	PG_ARRAY
spring.ai.postgresml.embedding.options.metadataMode	文档元数据聚合模式	EMBED

提示 所有以 spring.ai.postgresml.embedding.options 为前缀的属性都可以通过在 EmbeddingRequest 调用中添加请求特定的运行时选项来在运行时覆盖。

运行时选项

使用 PostgresMlEmbeddingOptions.java 配置 PostgresMlEmbeddingModel 的选项，如要使用的模型等。

在启动时，您可以将 PostgresMlEmbeddingOptions 传递给 PostgresMlEmbeddingModel 构造函数，以配置所有嵌入请求使用的默认选项。

在运行时，您可以在 EmbeddingRequest 中使用 PostgresMlEmbeddingOptions 来覆盖默认选项。

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

EmbeddingResponse embeddingResponse = embeddingModel.call(
    new EmbeddingRequest(List.of("Hello World", "World is big and salvation is near"),
            PostgresMlEmbeddingOptions.builder()
                .transformer("intfloat/e5-small")
                .vectorType(VectorType.PG_ARRAY)
                .kwargs(Map.of("device", "gpu"))
                .build()));

示例控制器

这将创建一个可以注入到类中的 EmbeddingModel 实现。以下是使用 EmbeddingModel 实现的简单 @Controller 类示例。

spring.ai.postgresml.embedding.options.transformer=distilbert-base-uncased
spring.ai.postgresml.embedding.options.vectorType=PG_ARRAY
spring.ai.postgresml.embedding.options.metadataMode=EMBED
spring.ai.postgresml.embedding.options.kwargs.device=cpu

@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 自动配置，您还可以手动创建 PostgresMlEmbeddingModel。为此，将 spring-ai-postgresml 依赖项添加到您项目的 Maven pom.xml 文件中：

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

或添加到您的 Gradle build.gradle 构建文件中。

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

提示 参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

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

var jdbcTemplate = new JdbcTemplate(dataSource); // your posgresml data source

PostgresMlEmbeddingModel embeddingModel = new PostgresMlEmbeddingModel(this.jdbcTemplate,
        PostgresMlEmbeddingOptions.builder()
            .transformer("distilbert-base-uncased") // huggingface transformer model name.
            .vectorType(VectorType.PG_VECTOR) //vector type in PostgreSQL.
            .kwargs(Map.of("device", "cpu")) // optional arguments.
            .metadataMode(MetadataMode.EMBED) // Document metadata mode.
            .build());

embeddingModel.afterPropertiesSet(); // initialize the jdbc template and database.

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

注意 手动创建时，必须在设置属性后、使用客户端之前调用 afterPropertiesSet()。将 PostgresMlEmbeddingModel 创建为 @Bean 更方便（也是首选的）。这样您就不必手动调用 afterPropertiesSet()：

@Bean
public EmbeddingModel embeddingModel(JdbcTemplate jdbcTemplate) {
    return new PostgresMlEmbeddingModel(jdbcTemplate,
        PostgresMlEmbeddingOptions.builder()
             ....
            .build());
}

---