PostgresML 嵌入

Spring AI 支持 PostgresML 文本嵌入模型。spring-doc.cadn.net.cn

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

许多预训练的LLMs可以用于在PostgresML中从文本生成嵌入。 您可以浏览所有模型,以在Hugging Face上找到最佳解决方案。spring-doc.cadn.net.cn

添加仓库和BOM

Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。 请参阅 工件仓库 部分,以将这些仓库添加到您的构建系统。spring-doc.cadn.net.cn

为了帮助管理依赖,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致的 Spring AI 版本。请参阅 依赖管理 部分,将 Spring AI BOM 添加到您的构建系统。spring-doc.cadn.net.cn

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 Azure PostgresML 嵌入模型提供了 Spring Boot 自动配置。 要启用它,请在项目的 Maven pom.xml 文件中添加以下依赖项:spring-doc.cadn.net.cn

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

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-postgresml-embedding'
}
参考以下依赖管理部分,添加Spring AI BOM到你的构建文件中。

使用 spring.ai.postgresml.embedding.options.* 属性来配置您的 PostgresMlEmbeddingModel。链接spring-doc.cadn.net.cn

嵌入属性

启用和禁用嵌入式自动配置现在通过带有前缀 spring.ai.model.embedding 的顶级属性进行配置。spring-doc.cadn.net.cn

要启用,请设置 spring.ai.model.embedding=postgresml (默认情况下已启用)spring-doc.cadn.net.cn

要禁用,请设置 spring.ai.model.embedding=none(或任何不匹配postgresml的值)spring-doc.cadn.net.cn

这种修改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.postgresml.embedding 是属性前缀,用于配置PostgresML嵌入的 EmbeddingModel 实现。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.postgresml.embedding.enabled(已移除,不再有效)spring-doc.cadn.net.cn

启用 PostgresML 嵌入式模型。spring-doc.cadn.net.cn

truespring-doc.cadn.net.cn

spring.ai.model.embeddingspring-doc.cadn.net.cn

启用 PostgresML 嵌入式模型。spring-doc.cadn.net.cn

postgresml -> PostgreSQL MLspring-doc.cadn.net.cn

spring.ai.postgresml.embedding.create-extensionspring-doc.cadn.net.cn

执行SQL 'CREATE EXTENSION IF NOT EXISTS pgml' 以启用该扩展spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

spring.ai.postgresml.embedding.options.transformerspring-doc.cadn.net.cn

要用于嵌入的Hugging Face转换器模型。spring-doc.cadn.net.cn

distilbert-base-uncasedspring-doc.cadn.net.cn

spring.ai.postgresml.embedding.options.kwargsspring-doc.cadn.net.cn

附加的转换器特定选项。spring-doc.cadn.net.cn

空映射spring-doc.cadn.net.cn

spring.ai.postgresml.embedding.options.vectorTypespring-doc.cadn.net.cn

用于嵌入的PostgresML向量类型。支持两种选项:PG_ARRAYPG_VECTORspring-doc.cadn.net.cn

PG_ARRAYspring-doc.cadn.net.cn

spring.ai.postgresml.embedding.options.metadataModespring-doc.cadn.net.cn

文档元数据聚合模式spring-doc.cadn.net.cn

EMBEDspring-doc.cadn.net.cn

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

运行时选项

使用 PostgresMlEmbeddingOptions.java 配置 PostgresMlEmbeddingModel,包括选择模型等选项。spring-doc.cadn.net.cn

启动时,您可以向PostgresMlEmbeddingModel构造函数传递一个PostgresMlEmbeddingOptions来配置用于所有嵌入请求的默认选项。spring-doc.cadn.net.cn

在运行时,您可以使用PostgresMlEmbeddingOptionsEmbeddingRequest中覆盖默认选项。spring-doc.cadn.net.cn

例如,要为特定请求覆盖默认的模型名称:spring-doc.cadn.net.cn

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-doc.cadn.net.cn

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文件中:spring-doc.cadn.net.cn

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

或者添加到您的Gradle 构建脚本文件中。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-postgresml'
}
参考以下依赖管理部分,添加Spring AI BOM到你的构建文件中。

接下来,创建一个PostgresMlEmbeddingModel实例,并使用它来计算两个输入文本之间的相似度:spring-doc.cadn.net.cn

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());
}