此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3spring-doc.cadn.net.cn

PostgresML 嵌入

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

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

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

添加仓库和BOM

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

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

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。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 build.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

<property> </property>spring-doc.cadn.net.cn

<description> </description>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

PostgresMLspring-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

嵌入spring-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

在运行时,您可以在 EmbeddingRequest 中使用 PostgresMlEmbeddingOptions 来覆盖默认选项。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);
    }
}

手动配置

您可以手动创建PostgresMlEmbeddingModel,而不使用 Spring Boot 自动配置。 为此,请将spring-ai-postgresml依赖项添加到项目的 Maven pom.xml文件中:spring-doc.cadn.net.cn

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

请将以下内容添加到您的Gradle build.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());
}