PGVectorStore 集成

使用 LangChain JavaScript 集成 PGVectorStore。

兼容性: 仅适用于 Node.js。

要启用通用 PostgreSQL 数据库中的向量搜索，LangChain.js 支持使用 pgvector Postgres 扩展。

本指南提供了快速入门 PGVector 向量存储 的概述。有关所有 PGVectorStore 功能和配置的详细文档，请访问 API 参考。

PGVectorStore 与 PGVector：选择哪一个？

LangChain 有两个 PostgreSQL 向量存储集成。以下是选择正确方案的方法：

功能	PGVector (传统)	PGVectorStore (现代)
包	langchain-community	langchain-postgres (Python) / @langchain/pgvector (JS)
维护	社区维护	官方合作伙伴包
连接	简单连接字符串	PGEngine (更好的连接池)
搜索类型	标准向量搜索	混合搜索 (向量 + BM25)
异步支持	有限	完全原生异步
模式	固定表结构	可自定义列和模式

使用 PGVectorStore (现代—推荐) 的情况：

• 开始任何新项目
• 需要混合搜索 (向量 + 关键词组合)
• 通过连接池获得更好的性能
• 构建异步应用程序 (例如，FastAPI, 异步 Node.js)

仅当以下情况使用 PGVector (传统)：

• 维护已使用它的现有代码库
• 跟随尚未更新的旧教程

对于所有新项目，我们推荐使用 PGVectorStore (来自 langchain-postgres (Python) 或 @langchain/community (JavaScript))。

---

概述

集成细节

类	包	PY 支持	下载量	版本
PGVectorStore	@langchain/pgvector	✅

设置

要使用 PGVector 向量存储，请设置一个已启用 pgvector 扩展的 PostgreSQL 实例，然后安装 @langchain/pgvector、pg 驱动程序和 @langchain/core。

本指南以 OpenAI 嵌入 为例。您也可以使用 其他支持的嵌入模型。

npm

npm install @langchain/pgvector @langchain/openai @langchain/core pg

设置实例

连接到 PostgreSQL 的方法有很多，具体取决于您如何设置实例。以下是一个使用 pgvector 团队提供的预构建 Docker 镜像进行本地设置的示例。

创建一个名为 docker-compose.yml 的文件，包含以下内容：

# Run this command to start the database:
# docker compose up
services:
  db:
    hostname: 127.0.0.1
    image: pgvector/pgvector:pg16
    ports:
      - 5432:5432
    restart: always
    environment:
      - POSTGRES_DB=api
      - POSTGRES_USER=myuser
      - POSTGRES_PASSWORD=ChangeMe

然后在同一目录中，运行 docker compose up 以启动容器。

有关如何设置 pgvector 的更多信息，请参阅 官方仓库。

凭证

要连接到您的 PostgreSQL 实例，您需要相应的凭证。有关所有支持选项的完整列表，请参阅 node-postgres 文档。

如果您在本指南中使用 OpenAI 嵌入，您还需要设置您的 OpenAI 密钥：

process.env.OPENAI_API_KEY = "YOUR_API_KEY";

如果您想自动跟踪您的模型调用，您也可以通过取消注释以下内容来设置您的 LangSmith API 密钥：

// process.env.LANGSMITH_TRACING="true"
// process.env.LANGSMITH_API_KEY="your-api-key"

实例化

要实例化向量存储，请调用 .initialize() 静态方法。这将自动检查传递的 config 中由 tableName 指定的表的是否存在。如果不存在，它将使用所需的列创建它。

安全: 用户生成数据（如用户名）不应用作表和列名称的输入。 这可能导致 SQL 注入！

import { PGVectorStore } from "@langchain/pgvector";
import type { DistanceStrategy } from "@langchain/pgvector";
import { OpenAIEmbeddings } from "@langchain/openai";
import type { PoolConfig } from "pg";

const embeddings = new OpenAIEmbeddings({
  model: "text-embedding-3-small",
});

// Sample config
const config = {
  postgresConnectionOptions: {
    type: "postgres",
    host: "127.0.0.1",
    port: 5433,
    user: "myuser",
    password: "ChangeMe",
    database: "api",
  } as PoolConfig,
  tableName: "testlangchainjs",
  columns: {
    idColumnName: "id",
    vectorColumnName: "vector",
    contentColumnName: "content",
    metadataColumnName: "metadata",
  },
  // supported distance strategies: cosine (default), innerProduct, or euclidean
  distanceStrategy: "cosine" as DistanceStrategy,
};

const vectorStore = await PGVectorStore.initialize(
  embeddings,
  config
);

管理向量存储

向向量存储添加项

import type { Document } from "@langchain/core/documents";

const document1: Document = {
  pageContent: "The powerhouse of the cell is the mitochondria",
  metadata: { source: "https://example.com" }
};

const document2: Document = {
  pageContent: "Buildings are made out of brick",
  metadata: { source: "https://example.com" }
};

const document3: Document = {
  pageContent: "Mitochondria are made out of lipids",
  metadata: { source: "https://example.com" }
};

const document4: Document = {
  pageContent: "The 2024 Olympics are in Paris",
  metadata: { source: "https://example.com" }
}

const documents = [document1, document2, document3, document4];

const ids = [crypto.randomUUID(), crypto.randomUUID(), crypto.randomUUID(), crypto.randomUUID()]

await vectorStore.addDocuments(documents, { ids: ids });

从向量存储删除项

const id4 = ids[ids.length - 1];

await vectorStore.delete({ ids: [id4] });

查询向量存储

一旦您的向量存储已创建，并且相关文档已添加，您很可能希望在链或智能体运行期间查询它。

直接查询

执行简单的相似度搜索如下：

const filter = { source: "https://example.com" };

const similaritySearchResults = await vectorStore.similaritySearch("biology", 2, filter);

for (const doc of similaritySearchResults) {
  console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
}

* The powerhouse of the cell is the mitochondria [{"source":"https://example.com"}]
* Mitochondria are made out of lipids [{"source":"https://example.com"}]

上述过滤器语法支持精确匹配，以下也受支持：

使用 in 运算符

{
  "field": {
    "in": ["value1", "value2"],
  }
}

使用 notIn 运算符

{
  "field": {
    "notIn": ["value1", "value2"],
  }
}

使用 arrayContains 运算符

{
  "field": {
    "arrayContains": ["value1", "value2"],
  }
}

如果您想执行相似度搜索并接收相应的分数，可以运行：

const similaritySearchWithScoreResults = await vectorStore.similaritySearchWithScore("biology", 2, filter)

for (const [doc, score] of similaritySearchWithScoreResults) {
  console.log(`* [SIM=${score.toFixed(3)}] ${doc.pageContent} [${JSON.stringify(doc.metadata)}]`);
}

* [SIM=0.835] The powerhouse of the cell is the mitochondria [{"source":"https://example.com"}]
* [SIM=0.852] Mitochondria are made out of lipids [{"source":"https://example.com"}]

将其转换为检索器进行查询

您还可以将向量存储转换为 检索器，以便在您的链中更轻松地使用。

const retriever = vectorStore.asRetriever({
  // Optional filter
  filter: filter,
  k: 2,
});
await retriever.invoke("biology");

[
  Document {
    pageContent: 'The powerhouse of the cell is the mitochondria',
    metadata: { source: 'https://example.com' },
    id: undefined
  },
  Document {
    pageContent: 'Mitochondria are made out of lipids',
    metadata: { source: 'https://example.com' },
    id: undefined
  }
]

用于检索增强生成

有关如何使用此向量存储进行检索增强生成 (RAG) 的指南，请参阅以下部分：

• 使用 LangChain 构建 RAG 应用.
• 智能体 RAG
• 检索文档

高级：重用连接

您可以通过创建连接池，然后直接通过构造函数创建新的 PGVectorStore 实例来重用连接。

请注意，您应该至少调用 .initialize() 来设置您的数据库一次，以正确设置表，然后再使用构造函数。

import { OpenAIEmbeddings } from "@langchain/openai";
import { PGVectorStore } from "@langchain/pgvector";
import pg from "pg";

const reusablePool = new pg.Pool({
  host: "127.0.0.1",
  port: 5433,
  user: "myuser",
  password: "ChangeMe",
  database: "api",
});

const originalConfig = {
  pool: reusablePool,
  tableName: "testlangchainjs",
  collectionName: "sample",
  collectionTableName: "collections",
  columns: {
    idColumnName: "id",
    vectorColumnName: "vector",
    contentColumnName: "content",
    metadataColumnName: "metadata",
  },
};

// Set up the DB.
// Can skip this step if you've already initialized the DB.
// await PGVectorStore.initialize(new OpenAIEmbeddings(), originalConfig);
const pgvectorStore = new PGVectorStore(new OpenAIEmbeddings(), originalConfig);

await pgvectorStore.addDocuments([
  { pageContent: "what's this", metadata: { a: 2 } },
  { pageContent: "Cat drinks milk", metadata: { a: 1 } },
]);

const results = await pgvectorStore.similaritySearch("water", 1);

console.log(results);

/*
  [ Document { pageContent: 'Cat drinks milk', metadata: { a: 1 } } ]
*/

const pgvectorStore2 = new PGVectorStore(new OpenAIEmbeddings(), {
  pool: reusablePool,
  tableName: "testlangchainjs",
  collectionTableName: "collections",
  collectionName: "some_other_collection",
  columns: {
    idColumnName: "id",
    vectorColumnName: "vector",
    contentColumnName: "content",
    metadataColumnName: "metadata",
  },
});

const results2 = await pgvectorStore2.similaritySearch("water", 1);

console.log(results2);

/*
  []
*/

await reusablePool.end();

创建 HNSW 索引

默认情况下，扩展执行顺序扫描搜索，具有 100% 的召回率。您可以考虑创建 HNSW 索引以进行近似最近邻 (ANN) 搜索，以加快 similaritySearchVectorWithScore 执行时间。要创建向量列上的 HNSW 索引，请使用 createHnswIndex() 方法。

该方法参数包括：

• dimensions：定义您的向量数据类型的维度数量，最多 2000。例如，对于 OpenAI 的 text-embedding-ada-002 和 Amazon 的 amazon.titan-embed-text-v1 模型，使用 1536。

• m?：每层的最大连接数（默认为 16）。较小的值可以提高索引构建时间，而较高的值可以加快搜索查询速度。

• efConstruction?：构建图时动态候选列表的大小（默认为 64）。较高的值可能会以索引构建时间为代价提高索引质量。

• distanceFunction?：您要使用的距离函数名称，根据距离策略自动选择。

有关更多信息，请参阅 Pgvector GitHub 仓库 和 Malkov Yu A. 和 Yashunin D. A. 2020. 使用分层可导航小世界图进行高效和鲁棒的近似最近邻搜索

import { OpenAIEmbeddings } from "@langchain/openai";
import { PGVectorStore } from "@langchain/pgvector";
import type { DistanceStrategy } from "@langchain/pgvector";
import type { PoolConfig } from "pg";


const hnswConfig = {
  postgresConnectionOptions: {
    type: "postgres",
    host: "127.0.0.1",
    port: 5433,
    user: "myuser",
    password: "ChangeMe",
    database: "api",
  } as PoolConfig,
  tableName: "testlangchainjs",
  columns: {
    idColumnName: "id",
    vectorColumnName: "vector",
    contentColumnName: "content",
    metadataColumnName: "metadata",
  },
  // supported distance strategies: cosine (default), innerProduct, or euclidean
  distanceStrategy: "cosine" as DistanceStrategy,
};

const hnswPgVectorStore = await PGVectorStore.initialize(
  new OpenAIEmbeddings(),
  hnswConfig
);

// create the index
await hnswPgVectorStore.createHnswIndex({
  dimensions: 1536,
  efConstruction: 64,
  m: 16,
});

await hnswPgVectorStore.addDocuments([
  { pageContent: "what's this", metadata: { a: 2, b: ["tag1", "tag2"] } },
  { pageContent: "Cat drinks milk", metadata: { a: 1, b: ["tag2"] } },
]);

const model = new OpenAIEmbeddings();
const query = await model.embedQuery("water");
const hnswResults = await hnswPgVectorStore.similaritySearchVectorWithScore(query, 1);

console.log(hnswResults);

await hnswPgVectorStore.end();

关闭连接

完成时确保关闭连接，以避免过度消耗资源：

await vectorStore.end();

---

API 参考

有关所有 PGVectorStore 功能和配置的详细文档，请访问 API 参考。

---

官方原文：src/oss/javascript/integrations/vectorstores/pgvector.mdx · 非官方翻译，译文由 AI 生成，以英文原文为准。