PostgresML 嵌入
Spring AI 支持 PostgresML 文本嵌入模型。
嵌入(Embeddings)是文本的数值表示形式,它们将单词和句子表示为向量,即一组数字数组。通过使用距离度量比较数值向量的相似性,嵌入可用于查找相似的文本片段;此外,由于大多数算法无法直接使用文本,嵌入也可用作其他机器学习模型的输入特征。
许多预训练的大型语言模型(LLM)可用于在PostgresML中从文本生成嵌入向量。您可以浏览所有可用的模型,在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 转换器模型。 | 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);
}
}
手动配置
不使用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());
}