PostgresML 嵌入
Spring AI 支持 PostgresML 文本嵌入模型。
嵌入(Embeddings)是文本的数字表示形式。它们用于将单词和句子表示为向量,即一组数字。通过使用距离度量比较数值向量的相似性,嵌入可以用于查找相似的文本片段,或者它们可以用作其他机器学习模型的输入特征,因为大多数算法无法直接使用文本。
许多预训练的 LLM 可以在 PostgresML 中用于从文本生成嵌入。你可以浏览所有可用的模型,在 Hugging Face 上找到最佳解决方案。
添加仓库和 BOM
Spring AI 工件发布在 Maven Central 和 Spring Snapshot 仓库中。请参考 Repositories 部分,将这些仓库添加到您的构建系统中。
为了帮助管理依赖项,Spring AI 提供了一个 BOM(物料清单),以确保在整个项目中使用一致版本的 Spring AI。请参考 依赖管理 部分,将 Spring AI BOM 添加到您的构建系统中。
自动配置
Spring AI 为 Azure PostgresML Embedding Model 提供了 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'
}
请参考依赖管理部分,将 Spring AI BOM 添加到您的构建文件中。
使用 spring.ai.postgresml.embedding.options.*
属性来配置你的 PostgresMlEmbeddingModel
。链接
嵌入属性
前缀 spring.ai.postgresml.embedding
是一个属性前缀,用于配置 PostgresML 嵌入的 EmbeddingModel
实现。
属性 | 描述 | 默认值 |
---|---|---|
spring.ai.postgresml.embedding.enabled | 启用 PostgresML 嵌入模型。 | true |
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);
}
}
手动配置
你可以手动创建 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());
}