Neo4j

Neo4j 是由 Neo4j, Inc 开发的图形数据库管理系统。

Neo4j 存储的数据元素是节点、连接它们的边以及节点和边的属性。其开发者将其描述为一个符合 ACID 的事务数据库，具有原生图形存储和处理功能，Neo4j 提供非开源的“社区版”，其许可证为 GNU 通用公共许可证的修改版，在线备份和高可用性扩展则在闭源商业许可证下授权。Neo 还在闭源商业条款下授权 Neo4j 及其扩展。

本笔记本展示了如何使用 LLM 提供自然语言接口，以便使用 Cypher 查询语言查询图形数据库。

Cypher 是一种声明性图形查询语言，允许在属性图中进行富有表现力和高效的数据查询。

设置

您需要有一个正在运行的 Neo4j 实例。一个选择是在他们的 Aura 云服务中创建一个免费的 Neo4j 数据库实例。您也可以使用 Neo4j Desktop 应用程序在本地运行数据库，或者运行一个 Docker 容器。
您可以通过执行以下脚本来运行本地 Docker 容器：

docker run \
    --name neo4j \
    -p 7474:7474 -p 7687:7687 \
    -d \
    -e NEO4J_AUTH=neo4j/password \
    -e NEO4J_PLUGINS=\[\"apoc\"\]  \
    neo4j:latest

如果您使用的是 Docker 容器，您需要等待几秒钟以让数据库启动。

from langchain.chains import GraphCypherQAChain
from langchain_community.graphs import Neo4jGraph
from langchain_openai import ChatOpenAI

graph = Neo4jGraph(url="bolt://localhost:7687", username="neo4j", password="password")

填充数据库

假设您的数据库是空的，您可以使用 Cypher 查询语言来填充它。以下 Cypher 语句是幂等的，这意味着如果您运行它一次或多次，数据库信息将保持不变。

graph.query(
    """
MERGE (m:Movie {name:"Top Gun", runtime: 120})
WITH m
UNWIND ["Tom Cruise", "Val Kilmer", "Anthony Edwards", "Meg Ryan"] AS actor
MERGE (a:Actor {name:actor})
MERGE (a)-[:ACTED_IN]->(m)
"""
)

[]

刷新图形模式信息

如果数据库的模式发生变化，您可以刷新生成 Cypher 语句所需的模式信息。

graph.refresh_schema()

print(graph.schema)

节点属性：
Movie {runtime: INTEGER, name: STRING}
Actor {name: STRING}
关系属性：

关系：
(:Actor)-[:ACTED_IN]->(:Movie)

增强的模式信息

选择增强的模式版本可以使系统自动扫描数据库中的示例值并计算一些分布指标。例如，如果一个节点属性的不同值少于 10 个，我们将返回模式中的所有可能值。否则，仅返回每个节点和关系属性的一个示例值。

enhanced_graph = Neo4jGraph(
    url="bolt://localhost:7687",
    username="neo4j",
    password="password",
    enhanced_schema=True,
)
print(enhanced_graph.schema)

Node properties:
- **Movie**
  - `runtime`: INTEGER Min: 120, Max: 120
  - `name`: STRING Available options: ['Top Gun']
- **Actor**
  - `name`: STRING Available options: ['Tom Cruise', 'Val Kilmer', 'Anthony Edwards', 'Meg Ryan']
Relationship properties:

The relationships:
(:Actor)-[:ACTED_IN]->(:Movie)

查询图形

我们现在可以使用图形 Cypher QA 链来询问图形

chain = GraphCypherQAChain.from_llm(
    ChatOpenAI(temperature=0), graph=graph, verbose=True
)

chain.invoke({"query": "Who played in Top Gun?"})

[1m> 进入新的 GraphCypherQAChain 链...[0m
生成的 Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
完整上下文:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> 完成链。[0m

{'query': 'Who played in Top Gun?',
 'result': 'Tom Cruise, Val Kilmer, Anthony Edwards, and Meg Ryan played in Top Gun.'}

限制结果数量

您可以使用 top_k 参数限制 Cypher QA Chain 的结果数量。默认值为 10。

chain = GraphCypherQAChain.from_llm(
    ChatOpenAI(temperature=0), graph=graph, verbose=True, top_k=2
)

chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
Full Context:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}][0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': 'Tom Cruise, Val Kilmer played in Top Gun.'}

返回中间结果

您可以使用 return_intermediate_steps 参数从 Cypher QA Chain 返回中间步骤

chain = GraphCypherQAChain.from_llm(
    ChatOpenAI(temperature=0), graph=graph, verbose=True, return_intermediate_steps=True
)

result = chain.invoke({"query": "Who played in Top Gun?"})
print(f"Intermediate steps: {result['intermediate_steps']}")
print(f"Final answer: {result['result']}")

[1m> 进入新的 GraphCypherQAChain 链...[0m
生成的 Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
完整上下文:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> 完成链。[0m
中间步骤: [{'query': "MATCH (a:Actor)-[:ACTED_IN]->(m:Movie)\nWHERE m.name = 'Top Gun'\nRETURN a.name"}, {'context': [{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}]}]
最终答案: Tom Cruise, Val Kilmer, Anthony Edwards 和 Meg Ryan 在《壮志凌云》中出演。

返回直接结果

您可以使用 return_direct 参数从 Cypher QA Chain 返回直接结果。

chain = GraphCypherQAChain.from_llm(
    ChatOpenAI(temperature=0), graph=graph, verbose=True, return_direct=True
)

chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': [{'a.name': 'Tom Cruise'},
  {'a.name': 'Val Kilmer'},
  {'a.name': 'Anthony Edwards'},
  {'a.name': 'Meg Ryan'}]}

在Cypher生成提示中添加示例

您可以定义希望LLM为特定问题生成的Cypher语句

from langchain_core.prompts.prompt import PromptTemplate

CYPHER_GENERATION_TEMPLATE = """Task:生成Cypher语句以查询图数据库。
Instructions:
仅使用模式中提供的关系类型和属性。
不要使用任何未提供的其他关系类型或属性。
Schema:
{schema}
Note: 请勿在您的回复中包含任何解释或道歉。
请勿回答任何可能询问您构建Cypher语句以外内容的问题。
请勿包含除生成的Cypher语句以外的任何文本。
Examples: 这是针对特定问题生成的Cypher语句的一些示例：
# 有多少人参与了《壮志凌云》？
MATCH (m:Movie {{name:"Top Gun"}})<-[:ACTED_IN]-()
RETURN count(*) AS numberOfActors

问题是：
{question}"""

CYPHER_GENERATION_PROMPT = PromptTemplate(
    input_variables=["schema", "question"], template=CYPHER_GENERATION_TEMPLATE
)

chain = GraphCypherQAChain.from_llm(
    ChatOpenAI(temperature=0),
    graph=graph,
    verbose=True,
    cypher_prompt=CYPHER_GENERATION_PROMPT,
)

chain.invoke({"query": "How many people played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (m:Movie {name:"Top Gun"})<-[:ACTED_IN]-()
RETURN count(*) AS numberOfActors[0m
Full Context:
[32;1m[1;3m[{'numberOfActors': 4}][0m

[1m> Finished chain.[0m

{'query': 'How many people played in Top Gun?',
 'result': '《壮志凌云》中有4位演员。'}

使用不同的 LLM 进行 Cypher 和答案生成

您可以使用 cypher_llm 和 qa_llm 参数来定义不同的 LLM

chain = GraphCypherQAChain.from_llm(
    graph=graph,
    cypher_llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo"),
    qa_llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo-16k"),
    verbose=True,
)

chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
Full Context:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': 'Tom Cruise, Val Kilmer, Anthony Edwards, and Meg Ryan played in Top Gun.'}

忽略指定的节点和关系类型

您可以使用 include_types 或 exclude_types 在生成 Cypher 语句时忽略图形模式的某些部分。

chain = GraphCypherQAChain.from_llm(
    graph=graph,
    cypher_llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo"),
    qa_llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo-16k"),
    verbose=True,
    exclude_types=["Movie"],
)

# Inspect graph schema
print(chain.graph_schema)

Node properties are the following:
Actor {name: STRING}
Relationship properties are the following:

The relationships are the following:

验证生成的 Cypher 语句

您可以使用 validate_cypher 参数来验证和纠正生成的 Cypher 语句中的关系方向。

chain = GraphCypherQAChain.from_llm(
    llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo"),
    graph=graph,
    verbose=True,
    validate_cypher=True,
)

chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
Full Context:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': 'Tom Cruise, Val Kilmer, Anthony Edwards, and Meg Ryan played in Top Gun.'}

从数据库结果提供上下文作为工具/功能输出

您可以使用 use_function_response 参数将数据库结果的上下文作为工具/功能输出传递给 LLM。这种方法提高了响应的准确性和相关性，因为 LLM 更加紧密地遵循提供的上下文。 您需要使用具有原生函数调用支持的 LLM 才能使用此功能。

chain = GraphCypherQAChain.from_llm(
    llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo"),
    graph=graph,
    verbose=True,
    use_function_response=True,
)
chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
Full Context:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': '在《壮志凌云》中主要演员是汤姆·克鲁斯、瓦尔·基尔默、安东尼·爱德华兹和梅格·瑞恩。'}

您可以通过提供 function_response_system 来提供自定义系统消息，以在使用功能响应功能时指导模型如何生成答案。

请注意，使用 use_function_response 时， qa_prompt 将没有效果。

chain = GraphCypherQAChain.from_llm(
    llm=ChatOpenAI(temperature=0, model="gpt-3.5-turbo"),
    graph=graph,
    verbose=True,
    use_function_response=True,
    function_response_system="Respond as a pirate!",
)
chain.invoke({"query": "Who played in Top Gun?"})

[1m> Entering new GraphCypherQAChain chain...[0m
Generated Cypher:
[32;1m[1;3mMATCH (a:Actor)-[:ACTED_IN]->(m:Movie)
WHERE m.name = 'Top Gun'
RETURN a.name[0m
Full Context:
[32;1m[1;3m[{'a.name': 'Tom Cruise'}, {'a.name': 'Val Kilmer'}, {'a.name': 'Anthony Edwards'}, {'a.name': 'Meg Ryan'}][0m

[1m> Finished chain.[0m

{'query': 'Who played in Top Gun?',
 'result': "哎呀，船员！在电影《壮志凌云》中，你会看到汤姆·克鲁斯、瓦尔·基尔默、安东尼·爱德华兹和梅格·瑞恩在天空的海洋中航行！他们是一支出色的演员团队！"}

Neo4j

设置

填充数据库

刷新图形模式信息

增强的模式信息

查询图形

限制结果数量

返回中间结果

返回直接结果

在Cypher生成提示中添加示例

使用不同的 LLM 进行 Cypher 和答案生成

忽略指定的节点和关系类型

验证生成的 Cypher 语句

从数据库结果提供上下文作为工具/功能输出

此页面是否有帮助？

您还可以留下详细的反馈在 GitHub 上

Neo4j

设置​

填充数据库​

刷新图形模式信息​

增强的模式信息​

查询图形​

限制结果数量​

返回中间结果​

返回直接结果​

在Cypher生成提示中添加示例​

使用不同的 LLM 进行 Cypher 和答案生成​

忽略指定的节点和关系类型​

验证生成的 Cypher 语句​

从数据库结果提供上下文作为工具/功能输出​

此页面是否有帮助？

您还可以留下详细的反馈 在 GitHub 上

设置

填充数据库

刷新图形模式信息

增强的模式信息

查询图形

限制结果数量

返回中间结果

返回直接结果

在Cypher生成提示中添加示例

使用不同的 LLM 进行 Cypher 和答案生成

忽略指定的节点和关系类型

验证生成的 Cypher 语句

从数据库结果提供上下文作为工具/功能输出

您还可以留下详细的反馈在 GitHub 上