PostgresML Embeddings

QWen 3.8 中英对照 PostgresML PostgresML Embeddings

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

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

许多预训练的大语言模型（LLM）都可用于在 PostgresML 中从文本生成嵌入。你可以在 Hugging Face 上浏览所有可用的模型，以找到最佳方案。

添加仓库和 BOM

Spring AI 工件已发布在 Maven Central 和 Spring Snapshot 仓库中。有关如何将这些仓库添加到您的构建系统，请参阅Artifact Repositories部分。

为协助依赖管理，Spring AI 提供了 BOM（物料清单），以确保在整个项目中使用一致版本的 Spring AI。请参考 依赖管理 章节，将 Spring AI BOM 添加到你的构建系统中。

自动配置

备注

Spring AI 的自动配置（auto-configuration）以及 starter 模块的制品（artifact）名称发生了重大变更。请查阅 升级说明 获取更多信息。

Spring AI 为 PostgresML Embedding Model 提供了 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.* 属性来配置 PostgresMlEmbeddingModel。链接

嵌入属性

备注

现在，通过具有前缀 spring.ai.model.embedding 的顶级属性来启用或禁用嵌入式自动配置。

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

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

此更改旨在支持配置多个模型。

前缀 spring.ai.postgresml.embedding 是用于配置 PostgresML embeddings 的 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.transformer	用于嵌入的 Hugging Face Transformer 模型。	distilbert-base-uncased
spring.ai.postgresml.embedding.kwargs	其他针对 Transformer 的具体选项。	empty map
spring.ai.postgresml.embedding.vector-type	用于嵌入的 PostgresML 向量类型。支持两个选项：PG_ARRAY 和 PG_VECTOR。	PG_ARRAY
spring.ai.postgresml.embedding.metadata-mode	文档元数据聚合模式	EMBED

提示

所有以 spring.ai.postgresml.embedding 为前缀的属性，都可以在运行时通过将请求特定的 Runtime Options 添加到 EmbeddingRequest 调用来覆盖。

运行时选项

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

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

在运行时，您可以在 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.transformer=distilbert-base-uncased
spring.ai.postgresml.embedding.vector-type=PG_ARRAY
spring.ai.postgresml.embedding.metadata-mode=EMBED
spring.ai.postgresml.embedding.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。为此，请在项目的 Maven pom.xml 文件中添加 spring-ai-postgresml 依赖：

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