以编程方式使用文档

> 使用 Gel 作为后端的 LangChain 向量存储抽象的实现 gel 作为后端。

Gel 是一个开源的 PostgreSQL 数据层,针对快速从开发到生产的周期进行了优化。它配备了一个高级的强类型类图数据模型、可组合的层级查询语言、完整的 SQL 支持、迁移功能、Auth 和 AI 模块。

代码位于名为 langchain-gel.

设置

首先安装相关包:

! pip install -qU gel langchain-gel

初始化

为了将 Gel 用作您的 VectorStore的后端,您需要一个可正常工作的 Gel 实例。 幸运的是,除非您想要,否则不必涉及 Docker 容器或任何复杂的东西!

要设置本地实例,请运行:

! gel project init --non-interactive

如果您正在使用 Gel Cloud (而且您应该这样做!),请在该命令中添加一个额外的参数:

gel project init --server-instance <org-name>/<instance-name>

有关运行 Gel 的全面方法列表,请参阅 运行 Gel 参考文档部分。

设置架构

Gel 架构 是应用程序数据模型的高级显式描述。 除了让您精确定义数据的布局方式外,它还驱动 Gel 的许多强大功能,如链接、访问策略、函数、触发器、约束、索引等。

LangChain 的 VectorStore需要以下架构布局:

schema_content = """
using extension pgvector;

module default {
    scalar type EmbeddingVector extending ext::pgvector::vector<1536>;

    type Record {
        required collection: str;
        text: str;
        embedding: EmbeddingVector;
        external_id: str {
            constraint exclusive;
        };
        metadata: json;

        index ext::pgvector::hnsw_cosine(m := 16, ef_construction := 128)
            on (.embedding)
    }
}
""".strip()

with open("dbschema/default.gel", "w") as f:
    f.write(schema_content)

为了将架构更改应用到数据库,请使用 Gel 的 迁移机制:

! gel migration create --non-interactive
! gel migrate

从这一点开始, GelVectorStore 可用作 LangChain 中任何其他向量存储的直接替代品。

实例化

# | output: false
# | echo: false
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-small")
from langchain_gel import GelVectorStore

vector_store = GelVectorStore(
    embeddings=embeddings,
)

管理向量存储

向向量存储添加项目

请注意,通过 ID 添加文档将覆盖任何匹配该 ID 的现有文档。

from langchain_core.documents import Document

docs = [
    Document(
        page_content="there are cats in the pond",
        metadata={"id": "1", "location": "pond", "topic": "animals"},
    ),
    Document(
        page_content="ducks are also found in the pond",
        metadata={"id": "2", "location": "pond", "topic": "animals"},
    ),
    Document(
        page_content="fresh apples are available at the market",
        metadata={"id": "3", "location": "market", "topic": "food"},
    ),
    Document(
        page_content="the market also sells fresh oranges",
        metadata={"id": "4", "location": "market", "topic": "food"},
    ),
    Document(
        page_content="the new art exhibit is fascinating",
        metadata={"id": "5", "location": "museum", "topic": "art"},
    ),
    Document(
        page_content="a sculpture exhibit is also at the museum",
        metadata={"id": "6", "location": "museum", "topic": "art"},
    ),
    Document(
        page_content="a new coffee shop opened on Main Street",
        metadata={"id": "7", "location": "Main Street", "topic": "food"},
    ),
    Document(
        page_content="the book club meets at the library",
        metadata={"id": "8", "location": "library", "topic": "reading"},
    ),
    Document(
        page_content="the library hosts a weekly story time for kids",
        metadata={"id": "9", "location": "library", "topic": "reading"},
    ),
    Document(
        page_content="a cooking class for beginners is offered at the community center",
        metadata={"id": "10", "location": "community center", "topic": "classes"},
    ),
]

vector_store.add_documents(docs, ids=[doc.metadata["id"] for doc in docs])

从向量存储删除项目

vector_store.delete(ids=["3"])

查询向量存储

一旦创建了向量存储并添加了相关文档,您很可能希望在链或代理运行时对其进行查询。

过滤支持

向量存储支持一组可应用于文档元数据字段的过滤器。

OperatorMeaning/Category
\$eqEquality (==)
\$neInequality (!=)
\$ltLess than (&lt;)
\$lteLess than or equal (&lt;=)
\$gtGreater than (>)
\$gteGreater than or equal (>=)
\$inSpecial Cased (in)
\$ninSpecial Cased (not in)
\$betweenSpecial Cased (between)
\$likeText (like)
\$ilikeText (case-insensitive like)
\$andLogical (and)
\$orLogical (or)

直接查询

执行简单的相似性搜索可以如下进行:

results = vector_store.similarity_search(
    "kitty", k=10, filter={"id": {"$in": ["1", "5", "2", "9"]}}
)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

如果您提供包含多个字段但没有运算符的字典,顶级将作为逻辑 **AND** 过滤器

vector_store.similarity_search(
    "ducks",
    k=10,
    filter={
        "id": {"$in": ["1", "5", "2", "9"]},
        "location": {"$in": ["pond", "market"]},
    },
)
vector_store.similarity_search(
    "ducks",
    k=10,
    filter={
        "$and": [
            {"id": {"$in": ["1", "5", "2", "9"]}},
            {"location": {"$in": ["pond", "market"]}},
        ]
    },
)

如果您想执行相似性搜索并接收相应的分数,可以运行:

results = vector_store.similarity_search_with_score(query="cats", k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

通过转换为检索器进行查询

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

retriever = vector_store.as_retriever(search_kwargs={"k": 1})
retriever.invoke("kitty")

检索增强生成的使用方法

有关如何使用此向量存储进行检索增强生成 (RAG) 的指南,请参阅以下章节:

API 参考

有关所有 GelVectorStore 功能和配置的详细文档,请前往 GitHub 文档.