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 是默认的嵌入维度
);

CREATE INDEX ON vector_store USING HNSW (embedding vector_cosine_ops);

提示：如果您使用不同的维度，请将 1536 替换为实际的嵌入维度。PGvector 对 HNSW 索引最多支持 2000 个维度。

接下来，如果需要，为 EmbeddingModel 准备一个 API 密钥，用于生成存储在 PgVectorStore 中的嵌入。

自动配置

Spring AI 的自动配置和启动器模块的构件名称发生了重大变化。请参阅升级说明了解更多信息。

然后，将 PgVectorStore 启动器依赖项添加到您的项目中：

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

或添加到 Gradle build.gradle 构建文件中：

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

向量存储实现可以为您初始化所需的模式，但您必须通过指定 initializeSchema 布尔值或在 application.properties 文件中设置 …initialize-schema=true 来选择加入。

注意：这是一个破坏性更改！在 Spring AI 的早期版本中，这种模式初始化是默认发生的。

向量存储还需要一个 EmbeddingModel 实例来计算文档的嵌入。您可以选择一个可用的 EmbeddingModel 实现。

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

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

或添加到 Gradle build.gradle 构建文件中：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}

提示：请参阅依赖管理部分，将 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
		max-document-batch-size: 10000 # 可选：每批最大文档数

提示：如果您通过 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")));

// 将文档添加到 PGVector
vectorStore.add(documents);

// 检索与查询相似的文档
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());

配置属性

您可以在 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.max-document-batch-size`	单批处理的最大文档数。	10000

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.max-document-batch-size

单批处理的最大文档数。

10000

提示：如果您配置了自定义模式和/或表名，请考虑通过设置 spring.ai.vectorstore.pgvector.schema-validation=true 启用模式验证。这确保了名称的正确性，并降低了 SQL 注入攻击的风险。

元数据过滤

您也可以利用通用的、可移植的元数据过滤器与 PgVector 存储。

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

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

或使用 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());

注意：这些过滤表达式被转换为 PostgreSQL JSON 路径表达式，用于高效的元数据过滤。

手动配置

除了使用 Spring Boot 自动配置外，您还可以手动配置 PgVectorStore。为此，您需要将 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>

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

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

@Bean
public VectorStore vectorStore(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
    return PgVectorStore.builder(jdbcTemplate, embeddingModel)
        .dimensions(1536)                    // 可选：默认为模型维度或 1536
        .distanceType(COSINE_DISTANCE)       // 可选：默认为 COSINE_DISTANCE
        .indexType(HNSW)                     // 可选：默认为 HNSW
        .initializeSchema(true)              // 可选：默认为 false
        .schemaName("public")                // 可选：默认为 "public"
        .vectorTableName("vector_store")     // 可选：默认为 "vector_store"
        .maxDocumentBatchSize(10000)         // 可选：默认为 10000
        .build();
}

在本地运行 Postgres & PGVector DB

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 存储实现通过 getNativeClient() 方法提供对底层原生 JDBC 客户端（JdbcTemplate）的访问：

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

if (nativeClient.isPresent()) {
    JdbcTemplate jdbc = nativeClient.get();
    // 使用原生客户端进行 PostgreSQL 特定的操作
}

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