PostgresML 嵌入

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

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

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

添加存储库和 BOM

Spring AI 工件发布在 Spring Milestone 和 Snapshot 存储库中。请参阅存储库部分以将这些存储库添加到您的构建系统。

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

自动配置

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

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

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

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

请参阅依赖项管理部分以将 Spring AI BOM 添加到您的构建文件中。

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

嵌入属性

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

属性

描述

默认值

spring.ai.postgresml.embedding.enabled

启用 PostgresML 嵌入模型。

true

spring.ai.postgresml.embedding.create-extension

执行 SQL 'CREATE EXTENSION IF NOT EXISTS pgml' 以启用扩展

false

spring.ai.postgresml.embedding.options.transformer

要用于嵌入的 Hugging Face 变压器模型。

distilbert-base-uncased

spring.ai.postgresml.embedding.options.kwargs

其他变压器特定选项。

空映射

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()
                .withTransformer("intfloat/e5-small")
                .withVectorType(VectorType.PG_ARRAY)
                .withKwargs(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);
    }
}

手动配置

您可以手动创建PostgresMlEmbeddingModel，而不是使用Spring Boot自动配置。为此，请将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()
            .withTransformer("distilbert-base-uncased") // huggingface transformer model name.
            .withVectorType(VectorType.PG_VECTOR) //vector type in PostgreSQL.
            .withKwargs(Map.of("device", "cpu")) // optional arguments.
            .withMetadataMode(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());
}