PostgresML嵌入

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

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

许多预训练的大型语言模型（LLMs）可以在PostgresML中用于从文本生成嵌入。您可以浏览所有可用的[模型](https://huggingface.co/models?library=sentence-transformers)来在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'
}

Tip	请参考依赖管理部分，将Spring AI BOM添加到您的构建文件中。

使用 spring.ai.postgresml.embedding.options.* 属性来配置你的 PostgresMlEmbeddingClient。链接

嵌入属性

前缀`spring.ai.postgresml.embedding`是一个属性前缀，用于配置PostgresML嵌入的`EmbeddingClient`实现。

属性

描述

默认值

spring.ai.postgresml.embedding.enabled

启用 PostgresML 嵌入式客户端。

true

spring.ai.postgresml.embedding.options.transformer

用于嵌入的 Huggingface 转换器模型。

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

Tip	所有以 `spring.ai.postgresml.embedding.options` 为前缀的属性都可以在运行时通过在 `EmbeddingRequest` 调用中添加特定请求的[embedding-options]来覆盖。

运行时选项

使用 https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-openai/src/main/java/org/springframework/ai/postgresml/PostgresMlEmbeddingOptions.java [PostgresMlEmbeddingOptions.java] 来配置 PostgresMlEmbeddingClient 的选项，例如使用的模型等等。

在开始时，你可以向`PostgresMlEmbeddingClient`构造函数传递一个`PostgresMlEmbeddingOptions`来配置用于所有嵌入请求的默认选项。

在运行时，您可以使用 EmbeddingRequest 中的 PostgresMlEmbeddingOptions 覆盖默认选项。

例如，要覆盖特定请求的默认模型名称：

EmbeddingResponse embeddingResponse = embeddingClient.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()));

样本控制器

这将创建一个你可以注入到你的类中的`EmbeddingClient`实现。以下是一个使用`EmbeddingClient`实现的简单`@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 EmbeddingClient embeddingClient;

@Autowired
    public EmbeddingController(EmbeddingClient embeddingClient) {
        this.embeddingClient = embeddingClient;
    }

@GetMapping("/ai/embedding")
    public Map embed(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        EmbeddingResponse embeddingResponse = this.embeddingClient.embedForResponse(List.of(message));
        return Map.of("embedding", embeddingResponse);
    }
}

手动配置

而不是使用Spring Boot自动配置，您可以手动创建`PostgresMlEmbeddingClient`。为此，将`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'
}

Tip	请参考依赖管理部分，将Spring AI BOM添加到您的构建文件中。

接下来，创建一个 PostgresMlEmbeddingClient 实例并使用它来计算两个输入文本之间的相似性：

var jdbcTemplate = new JdbcTemplate(dataSource); // your postgresql data source

PostgresMlEmbeddingClient embeddingClient = new PostgresMlEmbeddingClient(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());

embeddingClient.afterPropertiesSet(); // 初始化 jdbc 模板和数据库。

EmbeddingResponse embeddingResponse = embeddingClient
	.embedForResponse(List.of("Hello World", "World is big and salvation is near"));

Note	当手动创建时，您必须在设置属性之后以及在使用客户端之前调用 `afterPropertiesSet()` 方法。将 PostgresMlEmbeddingClient 作为 `@Bean` 创建会更加方便（并且是首选）。这样您就无需手动调用 `afterPropertiesSet()` 方法：

@Bean
public EmbeddingClient embeddingClient(JdbcTemplate jdbcTemplate) {
    return new PostgresMlEmbeddingClient(jdbcTemplate,
        PostgresMlEmbeddingOptions.builder()
             ....
            .build());
}