跳到主要内容

PGvector

DeepSeek V3 中英对照 PGvector

本节将引导您完成设置 PGvector VectorStore，以存储文档嵌入并执行相似性搜索。

PGvector 是一个开源的 PostgreSQL 扩展，支持存储和搜索由机器学习生成的嵌入向量。它提供了多种功能，使用户能够识别精确和近似的最近邻。它旨在与其他 PostgreSQL 功能（包括索引和查询）无缝协作。

先决条件​

首先，你需要访问一个启用了 vector、hstore 和 uuid-ossp 扩展的 PostgreSQL 实例。

提示

你可以通过 Docker Compose 或 Testcontainers 将 PGvector 数据库作为 Spring Boot 开发服务运行。或者，本地设置 Postgres/PGVector 附录展示了如何使用 Docker 容器在本地设置数据库。

在启动时，PgVectorStore 将尝试安装所需的数据库扩展，并在不存在的情况下创建带有索引的 vector_store 表。

可选地，你可以手动执行此操作，如下所示：

CREATE EXTENSION IF NOT EXISTS vector;
CREATE EXTENSION IF NOT EXISTS hstore;
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";

CREATE TABLE IF NOT EXISTS vector_store (
	id uuid DEFAULT uuid_generate_v4() PRIMARY KEY,
	content text,
	metadata json,
	embedding vector(1536) // 1536 is the default embedding dimension
);

CREATE INDEX ON vector_store USING HNSW (embedding vector_cosine_ops);
提示

如果你使用的是不同的维度，请将 1536 替换为实际的嵌入维度。PGvector 最多支持 2000 维度的 HNSW 索引。

接下来，如果需要，可以为 EmbeddingModel 生成一个 API 密钥，用于生成由 PgVectorStore 存储的嵌入。

自动配置​

然后在你的项目中添加 PgVectorStore 启动器依赖：

<dependency>
	<groupId>org.springframework.ai</groupId>
	<artifactId>spring-ai-pgvector-store-spring-boot-starter</artifactId>
</dependency>
xml

或到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-pgvector-store-spring-boot-starter'
}
groovy

向量存储实现可以为你初始化所需的 schema，但你必须通过在适当的构造函数中指定 initializeSchema 布尔值，或在 application.properties 文件中设置 …​initialize-schema=true 来选择启用。

备注

这是一个重大变更！在早期版本的 Spring AI 中，默认情况下会进行此模式初始化。

Vector Store 还需要一个 EmbeddingModel 实例来计算文档的嵌入向量。你可以从可用的 EmbeddingModel 实现 中选择一个。

例如，要使用 OpenAI EmbeddingModel，请将以下依赖项添加到你的项目中：

<dependency>
	<groupId>org.springframework.ai</groupId>
	<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>
xml

或者在您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
groovy
提示

请参考依赖管理部分，将 Spring AI BOM 添加到你的构建文件中。参考仓库部分，将 Maven Central 和/或 Snapshot 仓库添加到你的构建文件中。

要连接并配置 PgVectorStore，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.yml 提供一个简单的配置。

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: postgres
  ai:
	vectorstore:
	  pgvector:
		index-type: HNSW
		distance-type: COSINE_DISTANCE
		dimensions: 1536
		batching-strategy: TOKEN_COUNT # Optional: Controls how documents are batched for embedding
		max-document-batch-size: 10000 # Optional: Maximum number of documents per batch
提示

如果你通过 Docker Compose 或 Testcontainers 将 PGvector 作为 Spring Boot 开发服务运行，你不需要配置 URL、用户名和密码，因为它们由 Spring Boot 自动配置。

:::提示
查看 配置参数 列表以了解默认值和配置选项。
:::

现在你可以在应用程序中自动装配 VectorStore 并使用它

@Autowired VectorStore vectorStore;

// ...

List<Document> documents = List.of(
    new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
    new Document("The World is Big and Salvation Lurks Around the Corner"),
    new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));

// Add the documents to PGVector
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());
java

配置属性​

你可以在 Spring Boot 配置中使用以下属性来自定义 PGVector 向量存储。

属性描述默认值
spring.ai.vectorstore.pgvector.index-type最近邻搜索索引类型。选项为 NONE - 精确最近邻搜索，IVFFlat - 索引将向量划分为列表，然后搜索最接近查询向量的那些列表的子集。它的构建时间更快，使用的内存比 HNSW 少，但查询性能较低（在速度-召回权衡方面）。HNSW - 创建一个多层图。它的构建时间较慢，使用的内存比 IVFFlat 多，但查询性能更好（在速度-召回权衡方面）。没有像 IVFFlat 那样的训练步骤，因此可以在表中没有任何数据的情况下创建索引。HNSW
spring.ai.vectorstore.pgvector.distance-type搜索距离类型。默认为 COSINE_DISTANCE。但如果向量被归一化为长度 1，则可以使用 EUCLIDEAN_DISTANCE 或 NEGATIVE_INNER_PRODUCT 以获得最佳性能。COSINE_DISTANCE
spring.ai.vectorstore.pgvector.dimensions嵌入维度。如果未明确指定，PgVectorStore 将从提供的 EmbeddingModel 中检索维度。维度在表创建时设置为嵌入列。如果更改维度，您还必须重新创建 vector_store 表。-
spring.ai.vectorstore.pgvector.remove-existing-vector-store-table启动时删除现有的 vector_store 表。false
spring.ai.vectorstore.pgvector.initialize-schema是否初始化所需的模式false
spring.ai.vectorstore.pgvector.schema-name向量存储模式名称public
spring.ai.vectorstore.pgvector.table-name向量存储表名称vector_store
spring.ai.vectorstore.pgvector.schema-validation启用模式和表名称验证，以确保它们是有效且存在的对象。false
spring.ai.vectorstore.pgvector.batching-strategy计算嵌入时的文档批处理策略。选项为 TOKEN_COUNT 或 FIXED_SIZE。TOKEN_COUNT
spring.ai.vectorstore.pgvector.max-document-batch-size单批处理中处理的最大文档数。10000
提示

如果你配置了自定义的 schema 和/或表名，建议通过设置 spring.ai.vectorstore.pgvector.schema-validation=true 来启用 schema 验证。这可以确保名称的正确性，并降低 SQL 注入攻击的风险。

元数据过滤​

你可以利用通用的、可移植的元数据过滤器与 PgVector 存储一起使用。

例如，你可以使用文本表达式语言：

vectorStore.similaritySearch(
    SearchRequest.builder()
    .query("The World")
    .topK(TOP_K)
    .similarityThreshold(SIMILARITY_THRESHOLD)
    .filterExpression("author in ['john', 'jill'] && article_type == 'blog'").build());
java

或以编程方式使用 Filter.Expression DSL：

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.builder()
    .query("The World")
    .topK(TOP_K)
    .similarityThreshold(SIMILARITY_THRESHOLD)
    .filterExpression(b.and(
        b.in("author","john", "jill"),
        b.eq("article_type", "blog")).build()).build());
java
备注

这些过滤表达式会被转换为 PostgreSQL JSON 路径表达式，以实现高效的元数据过滤。

手动配置​

你可以手动配置 PgVectorStore，而不是使用 Spring Boot 的自动配置。为此，你需要将 PostgreSQL 连接和 JdbcTemplate 自动配置依赖项添加到你的项目中：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

<dependency>
	<groupId>org.postgresql</groupId>
	<artifactId>postgresql</artifactId>
	<scope>runtime</scope>
</dependency>

<dependency>
	<groupId>org.springframework.ai</groupId>
	<artifactId>spring-ai-pgvector-store</artifactId>
</dependency>
xml
提示

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

要在你的应用程序中配置 PgVector，可以使用以下设置：

@Bean
public VectorStore vectorStore(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
    return PgVectorStore.builder(jdbcTemplate, embeddingModel)
        .dimensions(1536)                    // Optional: defaults to model dimensions or 1536
        .distanceType(COSINE_DISTANCE)       // Optional: defaults to COSINE_DISTANCE
        .indexType(HNSW)                     // Optional: defaults to HNSW
        .initializeSchema(true)              // Optional: defaults to false
        .schemaName("public")                // Optional: defaults to "public"
        .vectorTableName("vector_store")     // Optional: defaults to "vector_store"
        .maxDocumentBatchSize(10000)         // Optional: defaults to 10000
        .build();
}
java

本地运行 Postgres 和 PGVector 数据库​

docker run -it --rm --name postgres -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres pgvector/pgvector

你可以像这样连接到这个服务器：

psql -U postgres -h localhost -p 5432

访问原生客户端​

PGVector Store 实现通过 getNativeClient() 方法提供了对底层原生 JDBC 客户端（JdbcTemplate）的访问：

PgVectorStore vectorStore = context.getBean(PgVectorStore.class);
Optional<JdbcTemplate> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    JdbcTemplate jdbc = nativeClient.get();
    // Use the native client for PostgreSQL-specific operations
}
java

原生客户端让你能够访问可能未通过 VectorStore 接口暴露的 PostgreSQL 特定功能和操作。