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

PostgresML 嵌入

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

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

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

添加存储库和 BOM

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

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

自动配置

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

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-postgresml-spring-boot-starter'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

使用属性配置 .链接spring.ai.postgresml.embedding.options.*PostgresMlEmbeddingModelspring-doc.cn

嵌入属性

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

财产spring-doc.cn

描述spring-doc.cn

违约spring-doc.cn

spring.ai.postgresml.embedding.enabledspring-doc.cn

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

spring-doc.cn

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

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

spring-doc.cn

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

用于嵌入的 Hugging Face transformer 模型。spring-doc.cn

distilbert-base-uncasedspring-doc.cn

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

其他转换器特定选项。spring-doc.cn

空地图spring-doc.cn

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

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

PG_ARRAYspring-doc.cn

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

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

嵌入spring-doc.cn

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

运行时选项

使用 PostgresMlEmbeddingOptions.java 配置 with 选项,例如要使用的模型等。PostgresMlEmbeddingModelspring-doc.cn

在启动时,你可以将 a 传递给构造函数,以配置用于所有嵌入请求的默认选项。PostgresMlEmbeddingOptionsPostgresMlEmbeddingModelspring-doc.cn

在运行时,您可以使用 .PostgresMlEmbeddingOptionsEmbeddingRequestspring-doc.cn

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

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

Samples控制器

这将创建一个可以注入到类中的实现。 下面是一个使用该实现的简单类的示例。EmbeddingModel@ControllerEmbeddingModelspring-doc.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 自动配置,而不是使用 Spring Boot 自动配置。 为此,请将依赖项添加到项目的 Maven 文件中:PostgresMlEmbeddingModelspring-ai-postgresmlpom.xmlspring-doc.cn

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-postgresml'
}
请参阅 Dependency Management 部分,将 Spring AI BOM 添加到您的构建文件中。

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

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"));
手动创建时,必须在设置属性之后和使用客户端之前调用 。 将 PostgresMlEmbeddingModel 创建为 . 然后,您不必手动调用 :afterPropertiesSet()@BeanafterPropertiesSet()
@Bean
public EmbeddingModel embeddingModel(JdbcTemplate jdbcTemplate) {
    return new PostgresMlEmbeddingModel(jdbcTemplate,
        PostgresMlEmbeddingOptions.builder()
             ....
            .build());
}