neo4j graphrag python下载 - neo4j graphrag python源码下载

适用于 Python 的 Neo4j GraphRAG 包

适用于 Python 的官方 Neo4j GraphRAG 包使开发人员能够使用 Neo4j 和 Python 的强大功能构建图形检索增强生成 (GraphRAG) 应用程序。作为第一方库，它提供了强大、功能丰富且高性能的解决方案，并直接从 Neo4j 进一步保证了长期支持和维护。

？文档

文档可以在这里找到

？ Python版本支持

版本	支持吗？
3.12	✓
3.11	✓
3.10	✓
3.9	✓
3.8	✗

？安装

要安装最新的稳定版本，请运行：

pip install neo4j-graphrag

可选依赖项

pygraphviz

pygraphviz用于可视化管道。您可以在此处找到安装说明。

用法示例

下面的脚本演示了如何开始使用该包并利用其主要功能。要运行这些示例，请确保您有一个 Neo4j 实例已启动并正在运行，并使用 Neo4j 实例的详细信息更新每个脚本中的NEO4J_URI 、 NEO4J_USERNAME和NEO4J_PASSWORD变量。对于示例，请确保将 OpenAI 密钥导出为名为OPENAI_API_KEY的环境变量。 examples夹中提供了其他示例。

知识图谱构建

注意：APOC 核心库必须安装在 Neo4j 实例中才能使用此功能

该包提供了两种构建知识图的方法。

Pipeline类提供了广泛的自定义选项，使其成为高级用例的理想选择。有关如何使用此类的示例，请参阅examples/pipeline文件夹。

对于更简化的方法， SimpleKGPipeline类在Pipeline上提供了一个简化的抽象层，使构建知识图变得更容易。这两个类都支持直接处理文本和 PDF。

 import asyncio

from neo4j import GraphDatabase
from neo4j_graphrag . embeddings import OpenAIEmbeddings
from neo4j_graphrag . experimental . pipeline . kg_builder import SimpleKGPipeline
from neo4j_graphrag . llm . openai_llm import OpenAILLM

NEO4J_URI = "neo4j://localhost:7687"
NEO4J_USERNAME = "neo4j"
NEO4J_PASSWORD = "password"

# Connect to the Neo4j database
driver = GraphDatabase . driver ( NEO4J_URI , auth = ( NEO4J_USERNAME , NEO4J_PASSWORD ))

# List the entities and relations the LLM should look for in the text
entities = [ "Person" , "House" , "Planet" ]
relations = [ "PARENT_OF" , "HEIR_OF" , "RULES" ]
potential_schema = [
    ( "Person" , "PARENT_OF" , "Person" ),
    ( "Person" , "HEIR_OF" , "House" ),
    ( "House" , "RULES" , "Planet" ),
]

# Create an Embedder object
embedder = OpenAIEmbeddings ( model = "text-embedding-3-large" )

# Instantiate the LLM
llm = OpenAILLM (
    model_name = "gpt-4o" ,
    model_params = {
        "max_tokens" : 2000 ,
        "response_format" : { "type" : "json_object" },
        "temperature" : 0 ,
    },
)

# Instantiate the SimpleKGPipeline
kg_builder = SimpleKGPipeline (
    llm = llm ,
    driver = driver ,
    embedder = embedder ,
    entities = entities ,
    relations = relations ,
    on_error = "IGNORE" ,
    from_pdf = False ,
)

# Run the pipeline on a piece of text
text = (
    "The son of Duke Leto Atreides and the Lady Jessica, Paul is the heir of House "
    "Atreides, an aristocratic family that rules the planet Caladan."
)
asyncio . run ( kg_builder . run_async ( text = text ))
driver . close ()

使用上述脚本创建的知识图示例：

创建向量索引

创建向量索引时，请确保索引中的维数与嵌入的维数相匹配。

 from neo4j import GraphDatabase
from neo4j_graphrag . indexes import create_vector_index

NEO4J_URI = "neo4j://localhost:7687"
NEO4J_USERNAME = "neo4j"
NEO4J_PASSWORD = "password"
INDEX_NAME = "vector-index-name"

# Connect to the Neo4j database
driver = GraphDatabase . driver ( NEO4J_URI , auth = ( NEO4J_USERNAME , NEO4J_PASSWORD ))

# Create the index
create_vector_index (
    driver ,
    INDEX_NAME ,
    label = "Chunk" ,
    embedding_property = "embedding" ,
    dimensions = 3072 ,
    similarity_fn = "euclidean" ,
)
driver . close ()

填充向量索引

此示例演示了一种在 Neo4j 数据库中更新插入数据的方法。值得注意的是，还有其他方法，例如使用 Neo4j Python 驱动程序。

确保在执行此示例之前创建向量索引。

 from neo4j import GraphDatabase
from neo4j_graphrag . embeddings import OpenAIEmbeddings
from neo4j_graphrag . indexes import upsert_vector

NEO4J_URI = "neo4j://localhost:7687"
NEO4J_USERNAME = "neo4j"
NEO4J_PASSWORD = "password"

# Connect to the Neo4j database
driver = GraphDatabase . driver ( NEO4J_URI , auth = ( NEO4J_USERNAME , NEO4J_PASSWORD ))

# Create an Embedder object
embedder = OpenAIEmbeddings ( model = "text-embedding-3-large" )

# Generate an embedding for some text
text = (
    "The son of Duke Leto Atreides and the Lady Jessica, Paul is the heir of House "
    "Atreides, an aristocratic family that rules the planet Caladan."
)
vector = embedder . embed_query ( text )

# Upsert the vector
upsert_vector (
    driver ,
    node_id = 0 ,
    embedding_property = "embedding" ,
    vector = vector ,
)
driver . close ()

执行相似性搜索

请注意，查询 Neo4j 向量索引时，使用近似最近邻搜索，这可能并不总是提供准确的结果。有关更多信息，请参阅有关向量索引的限制和问题的 Neo4j 文档。

在下面的示例中，我们使用检索器执行简单的向量搜索，该检索器对vector-index-name向量索引进行相似性搜索。

该库提供了除VectorRetriever之外的更多检索器。有关如何使用这些检索器的示例，请参阅examples文件夹。

在运行此示例之前，请确保已创建并填充向量索引。

 from neo4j import GraphDatabase
from neo4j_graphrag . embeddings import OpenAIEmbeddings
from neo4j_graphrag . generation import GraphRAG
from neo4j_graphrag . llm import OpenAILLM
from neo4j_graphrag . retrievers import VectorRetriever

NEO4J_URI = "neo4j://localhost:7687"
NEO4J_USERNAME = "neo4j"
NEO4J_PASSWORD = "password"
INDEX_NAME = "vector-index-name"

# Connect to the Neo4j database
driver = GraphDatabase . driver ( NEO4J_URI , auth = ( NEO4J_USERNAME , NEO4J_PASSWORD ))

# Create an Embedder object
embedder = OpenAIEmbeddings ( model = "text-embedding-3-large" )

# Initialize the retriever
retriever = VectorRetriever ( driver , INDEX_NAME , embedder )

# Instantiate the LLM
llm = OpenAILLM ( model_name = "gpt-4o" , model_params = { "temperature" : 0 })

# Instantiate the RAG pipeline
rag = GraphRAG ( retriever = retriever , llm = llm )

# Query the graph
query_text = "Who is Paul Atreides?"
response = rag . search ( query_text = query_text , retriever_config = { "top_k" : 5 })
print ( response . answer )
driver . close ()

？贡献

您必须签署贡献者许可协议才能为本项目做出贡献。

安装依赖项

我们的 Python 依赖项是使用 Poetry 来管理的。如果您的系统上尚未安装 Poetry，您可以按照此处的说明进行设置。要开始此项目的开发，请首先克隆存储库，然后使用以下命令安装所有必要的依赖项，包括开发依赖项：

poetry install --with dev

报告问题

如果您需要报告错误或请求功能，请首先搜索以查看问题是否已存在。如果不存在相关问题，请使用问题表单提出新问题。

如果您是 Neo4j Enterprise 客户，您还可以联系客户支持。

如果您没有要报告的错误或功能请求，但需要库的帮助；可通过 Neo4j 在线社区和/或 Discord 获得社区支持。

贡献工作流程

分叉存储库。
安装 Python 和 Poetry。
从main创建一个工作分支并开始进行更改！

代码格式化和 Linting

我们的代码库遵循严格的格式和 linting 标准，使用 Ruff 进行代码质量检查，使用 Mypy 进行类型检查。在贡献之前，请确保所有代码格式正确，没有 linting 问题，并且包含准确的类型注释。

要安装 Ruff，请按照此处的说明进行操作。
要设置 Mypy，请按照此处概述的步骤操作。

贡献必须遵守这些标准才能被接受。

使用预提交

我们建议设置预提交来自动检查代码质量。这可以确保您的更改在提交之前符合我们的准则。

按照安装指南安装预提交。
通过运行以下命令设置预提交挂钩：
```
pre-commit install
```
要手动检查文件是否满足质量要求，请运行：
```
pre-commit run --file path/to/file
```

请求请求

完成更改后，请使用以下工作流程创建拉取请求 (PR)。

确保您已格式化并检查了代码。
确保您已签署 CLA。
确保 PR 的基础设置为main 。
如果您正在解决某个问题，请不要忘记将您的 PR 链接到该问题。
选中该复选框以允许维护者编辑，以便维护者可以进行任何必要的调整并更新您的分支以进行合并。
审阅者可能会要求在合并 PR 之前进行更改，无论是使用建议的更改还是正常的拉取请求评论。您可以直接通过 UI 应用建议的更改。任何其他更改都可以在您的分叉中进行并提交给 PR 分支。
当您更新 PR 并应用更改时，将每个对话标记为已解决。
如果您对项目进行了重大更改，请更新CHANGELOG.md ，其中包括：
- 主要变化：
  - 新功能
  - 具有高影响力的错误修复
  - 重大变化
- 小改动：
  - 文档改进
  - 代码重构不影响功能
  - 小错误修复
保持CHANGELOG.md更改简短并关注最重要的更改。

更新`CHANGELOG.md`

您可以使用 CodiumAI 进行评论，自动为您的 PR 生成变更日志建议：

 @CodiumAI-Agent /update_changelog

如有必要，请编辑建议并更新CHANGELOG.md文件中“下一步”下的相应小节。
提交更改。

？测试

单元测试

安装项目依赖项，然后运行以下命令在本地运行单元测试：

poetry run pytest tests/unit

端到端测试

要执行端到端 (e2e) 测试，您需要在本地运行以下服务：

新4j
编织
weaviate-text2vec-变压器

设置这些的最简单方法是使用 Docker Compose：

docker compose -f tests/e2e/docker-compose.yml up

（提示：如果您在数据库中遇到任何缓存问题，可以通过运行docker compose -f tests/e2e/docker-compose.yml down来完全删除它们）

所有服务运行后，执行以下命令来运行 e2e 测试：

poetry run pytest tests/e2e

附加信息

官方 Neo4j Python 驱动程序
Neo4j GenAI 集成

展开

neo4j graphrag python

适用于 Python 的 Neo4j GraphRAG 包

？文档

？ Python版本支持

？安装

可选依赖项

pygraphviz

用法示例

知识图谱构建

创建向量索引

填充向量索引

执行相似性搜索

？贡献

安装依赖项

报告问题

贡献工作流程

代码格式化和 Linting

使用预提交

请求请求

更新`CHANGELOG.md`

？测试

单元测试

端到端测试

附加信息

Python Portfolio

datamule python

stripe python

automaited python

Python源代码 python管理系统 python源码 python案例 python系统

深入Python:Dive Into Python 中文版

chat.petals.dev

GPT Prompt Templates

GPTyped

node telegram bot api

typebot.io

python wechaty getting started

waymo open dataset

termwind

wp functions

neo4j graphrag python

适用于 Python 的 Neo4j GraphRAG 包

？文档

？ Python版本支持

？安装

可选依赖项

pygraphviz

用法示例

知识图谱构建

创建向量索引

填充向量索引

执行相似性搜索

？贡献

安装依赖项

报告问题

贡献工作流程

代码格式化和 Linting

使用预提交

请求请求

更新CHANGELOG.md

？测试

单元测试

端到端测试

附加信息

更新`CHANGELOG.md`