PostgresML 嵌入

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

嵌入是文字的數字表示。它們用於將單詞和句子表示為向量(一個數字陣列)。透過使用距離度量比較數值向量的相似性,嵌入可用於查詢相似的文字片段,或者它們可以用作其他機器學習模型的輸入特徵,因為大多數演算法無法直接使用文字。

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

新增倉庫和 BOM

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

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

自動配置

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

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' 以啟用擴充套件

false

spring.ai.postgresml.embedding.options.transformer

用於嵌入的 Hugging Face Transformer 模型。

distilbert-base-uncased

spring.ai.postgresml.embedding.options.kwargs

額外的 Transformer 特有選項。

空對映

spring.ai.postgresml.embedding.options.vectorType

用於嵌入的 PostgresML 向量型別。支援兩個選項:PG_ARRAYPG_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()));

示例 Controller

這將建立一個 EmbeddingModel 實現,您可以將其注入到您的類中。這裡是一個簡單的 @Controller 類使用 EmbeddingModel 實現的示例。

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 自動配置外,您還可以手動建立 PostgresMlEmbeddingModel。為此,請將 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());
}