PostgresML 嵌入

Spring AI 支援 PostgresML 文字嵌入模型。

嵌入是文字的數字表示。它們用於將單詞和句子表示為向量，即一組數字。嵌入可以透過比較數字向量之間的相似性（使用距離度量）來查詢相似的文字片段，或者它們可以用作其他機器學習模型的輸入特徵，因為大多數演算法不能直接使用文字。

許多預訓練的 LLM 可以在 PostgresML 中用於從文字生成嵌入。您可以在 Hugging Face 上瀏覽所有可用的模型，找到最佳解決方案。

新增儲存庫和 BOM

Spring AI 工件釋出在 Maven Central 和 Spring Snapshot 儲存庫中。請參閱工件儲存庫部分，將這些儲存庫新增到您的構建系統。

為了幫助管理依賴項，Spring AI 提供了一個 BOM（物料清單），以確保在整個專案中使用的 Spring AI 版本一致。請參閱依賴項管理部分，將 Spring AI BOM 新增到您的構建系統。

自動配置

Spring AI 自動配置、啟動模組的工件名稱發生了重大變化。請參閱升級說明以獲取更多資訊。

Spring AI 為 Azure PostgresML 嵌入模型提供 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.options.* 屬性配置您的 PostgresMlEmbeddingModel。連結

嵌入屬性

嵌入自動配置的啟用和停用現在透過字首為 spring.ai.model.embedding 的頂級屬性進行配置。

要啟用，spring.ai.model.embedding=postgresml（預設已啟用）

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

此更改是為了允許配置多個模型。

字首 spring.ai.postgresml.embedding 是屬性字首，用於配置 PostgresML 嵌入的 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' 以啟用擴充套件

假

spring.ai.postgresml.embedding.options.transformer

用於嵌入的 Hugging Face 轉換器模型。

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

所有以 spring.ai.postgresml.embedding.options 為字首的屬性都可以在執行時透過在 EmbeddingRequest 呼叫中新增請求特定的執行時選項來覆蓋。

執行時選項

使用 PostgresMlEmbeddingOptions.java 配置 PostgresMlEmbeddingModel 的選項，例如要使用的模型等。

在啟動時，您可以將 PostgresMlEmbeddingOptions 傳遞給 PostgresMlEmbeddingModel 建構函式，以配置所有嵌入請求的預設選項。

在執行時，您可以在 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.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 檔案中

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