Skip to main content
Open In ColabOpen on GitHub

Kuzu

Kùzu 是一个可嵌入、可扩展且速度极快的图数据库。 它采用宽松的 MIT 许可证授权，您可以在此处查看其源代码：这里。

Kùzu 的关键特性：

  • 性能和可扩展性：为图实现了现代最先进的连接算法。
  • 易用性：设置和开始使用非常简单，因为没有服务器（嵌入式架构）。
  • 互操作性：可以方便地从外部列式格式、CSV、JSON 和关系型数据库中扫描并复制数据。
  • 结构化属性图模型：实现属性图模型，并增加了结构。
  • Cypher 支持：允许使用声明式查询语言 Cypher 方便地查询图。

通过访问他们的 文档 开始使用 Kùzu。

设置​

Kùzu 是一个嵌入式数据库（它在进程中运行），因此无需管理服务器。安装以下依赖项即可开始：

pip install -U langchain-kuzu langchain-openai langchain-experimental

这将安装 Kùzu 及其与 LangChain 的集成，同时还会安装 OpenAI Python 包，以便我们可以使用 OpenAI 的大语言模型（LLM）。如果你想使用其他 LLM 提供商，可以安装它们各自与 LangChain 配套的 Python 包。

以下是如何在本地机器上首先创建一个 Kùzu 数据库并连接到它的步骤：

import kuzu

db = kuzu.Database("test_db")
conn = kuzu.Connection(db)

创建 KuzuGraph​

Kùzu 与 LangChain 的集成使得从非结构化文本创建和更新图变得非常方便，同时也可通过利用 LangChain 的 LLM 链功能的 Text2Cypher 管道来查询图。首先，我们创建一个 KuzuGraph 对象，该对象结合了上面创建的数据库对象以及 KuzuGraph 构造函数。

from langchain_kuzu.graphs.kuzu_graph import KuzuGraph

graph = KuzuGraph(db, allow_dangerous_requests=True)

假设我们想要将以下文本转换为图结构：

text = "Tim Cook is the CEO of Apple. Apple has its headquarters in California."

我们将使用LLMGraphTransformer来利用大语言模型（LLM）从文本中提取节点和关系。 为了使图谱更加有用，我们将定义以下模式，以便LLM仅提取符合该模式的节点和关系。

# Define schema
allowed_nodes = ["Person", "Company", "Location"]
allowed_relationships = [
    ("Person", "IS_CEO_OF", "Company"),
    ("Company", "HAS_HEADQUARTERS_IN", "Location"),
]

LLMGraphTransformer 类提供了一种便捷的方式，将文本转换为图形文档的列表。

from langchain_core.documents import Document
from langchain_experimental.graph_transformers import LLMGraphTransformer
from langchain_openai import ChatOpenAI

# Define the LLMGraphTransformer
llm_transformer = LLMGraphTransformer(
    llm=ChatOpenAI(model="gpt-4o-mini", temperature=0, api_key=OPENAI_API_KEY),  # noqa: F821
    allowed_nodes=allowed_nodes,
    allowed_relationships=allowed_relationships,
)

documents = [Document(page_content=text)]
graph_documents = llm_transformer.convert_to_graph_documents(documents)
graph_documents[:2]
[GraphDocument(nodes=[Node(id='Tim Cook', type='Person', properties={}), Node(id='Apple', type='Company', properties={}), Node(id='California', type='Location', properties={})], relationships=[Relationship(source=Node(id='Tim Cook', type='Person', properties={}), target=Node(id='Apple', type='Company', properties={}), type='IS_CEO_OF', properties={}), Relationship(source=Node(id='Apple', type='Company', properties={}), target=Node(id='California', type='Location', properties={}), type='HAS_HEADQUARTERS_IN', properties={})], source=Document(metadata={}, page_content='Tim Cook is the CEO of Apple. Apple has its headquarters in California.'))]

我们随后可以调用上述定义的 KuzuGraph 对象的 add_graph_documents 方法，将图文档注入到 Kùzu 数据库中。 其中 include_source 参数被设置为 True，以便在每个实体节点与其来源文档之间建立关系。

# Add the graph document to the graph
graph.add_graph_documents(
    graph_documents,
    include_source=True,
)

创建 KuzuQAChain​

要通过 Text2Cypher 管道查询图谱，我们可以定义一个 KuzuQAChain 对象。然后，可以通过连接到上面定义的 test_db 目录中存储的现有数据库，使用查询来调用该链。

from langchain_kuzu.chains.graph_qa.kuzu import KuzuQAChain

# Create the KuzuQAChain with verbosity enabled to see the generated Cypher queries
chain = KuzuQAChain.from_llm(
    llm=ChatOpenAI(model="gpt-4o-mini", temperature=0.3, api_key=OPENAI_API_KEY),  # noqa: F821
    graph=graph,
    verbose=True,
    allow_dangerous_requests=True,
)

请注意，我们将温度设置得略高于零，以避免大语言模型（LLM）在回答时过于简洁。

让我们使用问答链来提出一些问题。

chain.invoke("Who is the CEO of Apple?")


> Entering new KuzuQAChain chain...
Generated Cypher:
MATCH (p:Person)-[:IS_CEO_OF]->(c:Company {id: 'Apple'}) RETURN p
Full Context:
[{'p': {'_id': {'offset': 0, 'table': 1}, '_label': 'Person', 'id': 'Tim Cook', 'type': 'entity'}}]

> Finished chain.
{'query': 'Who is the CEO of Apple?',
 'result': 'Tim Cook is the CEO of Apple.'}
chain.invoke("Where is Apple headquartered?")


> Entering new KuzuQAChain chain...
Generated Cypher:
MATCH (c:Company {id: 'Apple'})-[:HAS_HEADQUARTERS_IN]->(l:Location) RETURN l
Full Context:
[{'l': {'_id': {'offset': 0, 'table': 2}, '_label': 'Location', 'id': 'California', 'type': 'entity'}}]

> Finished chain.
{'query': 'Where is Apple headquartered?',
 'result': 'Apple is headquartered in California.'}

刷新图谱结构​

如果你修改或更新了图，可以检查用于 Text2Cypher 链以生成 Cypher 语句的刷新后的模式信息。 你无需每次手动调用 refresh_schema()，因为在调用链时会自动执行该操作。

graph.refresh_schema()

print(graph.get_schema)
Node properties: [{'properties': [('id', 'STRING'), ('type', 'STRING')], 'label': 'Person'}, {'properties': [('id', 'STRING'), ('type', 'STRING')], 'label': 'Location'}, {'properties': [('id', 'STRING'), ('text', 'STRING'), ('type', 'STRING')], 'label': 'Chunk'}, {'properties': [('id', 'STRING'), ('type', 'STRING')], 'label': 'Company'}]
Relationships properties: [{'properties': [], 'label': 'HAS_HEADQUARTERS_IN'}, {'properties': [('label', 'STRING'), ('triplet_source_id', 'STRING')], 'label': 'MENTIONS_Chunk_Person'}, {'properties': [('label', 'STRING'), ('triplet_source_id', 'STRING')], 'label': 'MENTIONS_Chunk_Location'}, {'properties': [], 'label': 'IS_CEO_OF'}, {'properties': [('label', 'STRING'), ('triplet_source_id', 'STRING')], 'label': 'MENTIONS_Chunk_Company'}]
Relationships: ['(:Company)-[:HAS_HEADQUARTERS_IN]->(:Location)', '(:Chunk)-[:MENTIONS_Chunk_Person]->(:Person)', '(:Chunk)-[:MENTIONS_Chunk_Location]->(:Location)', '(:Person)-[:IS_CEO_OF]->(:Company)', '(:Chunk)-[:MENTIONS_Chunk_Company]->(:Company)']

为 Cypher 和答案生成使用独立的 LLM​

您可以分别指定 cypher_llm 和 qa_llm，以对 Cypher 生成和答案生成使用不同的大语言模型（LLM）。

chain = KuzuQAChain.from_llm(
    cypher_llm=ChatOpenAI(temperature=0, model="gpt-4o-mini"),
    qa_llm=ChatOpenAI(temperature=0, model="gpt-4"),
    graph=graph,
    verbose=True,
    allow_dangerous_requests=True,
)
chain.invoke("Who is the CEO of Apple?")


> Entering new KuzuQAChain chain...
Generated Cypher:
MATCH (p:Person)-[:IS_CEO_OF]->(c:Company {id: 'Apple'}) RETURN p.id, p.type
Full Context:
[{'p.id': 'Tim Cook', 'p.type': 'entity'}]

> Finished chain.
{'query': 'Who is the CEO of Apple?',
 'result': 'Tim Cook is the CEO of Apple.'}