PGvector

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

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

先决条件

首先，您需要访问已启用 vector、hstore 和 uuid-ossp 扩展的 PostgreSQL 实例。

您可以通过 Docker Compose 或 Testcontainers 作为 Spring Boot 开发服务运行 PGvector 数据库。或者，设置本地 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 对 HNSW 索引最多支持 2000 个维度。

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

自动配置

然后将 PgVectorStore 启动程序依赖项添加到您的项目中

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

或添加到您的 Gradle build.gradle 构建文件中。

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

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

这是一个重大更改！在早期版本的 Spring AI 中，此模式初始化默认发生。

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

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

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

或添加到您的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 依赖项管理 部分，以将 Spring AI BOM 添加到您的构建文件中。请参阅 存储库 部分，以将里程碑和/或快照存储库添加到您的构建文件中。

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

spring:
  datasource:
    url: jdbc:postgresql://127.0.0.1:5432/postgres
    username: postgres
    password: postgres
  ai:
	vectorstore:
	  pgvector:
		index-type: HNSW
		distance-type: COSINE_DISTANCE
		dimensions: 1536
如果您通过 Docker Compose 或 Testcontainers 将 PGvector 作为 Spring Boot 开发服务运行，则无需配置 URL、用户名和密码，因为它们由 Spring Boot 自动配置。
查看 配置参数 列表，以了解默认值和配置选项。

现在，您可以在应用程序中自动连接 PgVectorStore 并使用它

@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.query("Spring").withTopK(5));

配置属性

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

属性 描述 默认值

spring.ai.vectorstore.pgvector.index-type

最近邻搜索索引类型。选项包括：NONE - 精确最近邻搜索，IVFFlat - 将向量划分为列表，然后搜索与查询向量最接近的列表子集。它具有更快的构建时间并使用更少的内存，但查询性能较低（在速度-召回权衡方面）。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.schema-validation=true 来启用模式验证。这确保了名称的正确性并降低了 SQL 注入攻击的风险。

元数据过滤

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

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

vectorStore.similaritySearch(
    SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression("author in ['john', 'jill'] && article_type == 'blog'"));

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

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression(b.and(
        b.in("author","john", "jill"),
        b.eq("article_type", "blog")).build()));
这些过滤器表达式将转换为等效的 PgVector 过滤器。

手动配置

您可以手动配置 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>
请参阅 依赖项管理 部分以将 Spring AI BOM 添加到您的构建文件中。

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

@Bean
public VectorStore vectorStore(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
	return new PgVectorStore(jdbcTemplate, embeddingModel);
}

在本地运行 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