Skip to main content

Domain-agnostic Graph RAG framework for building governed, auditable Knowledge Graphs

Project description

graphrag-core

A domain-agnostic framework for building governed, auditable Knowledge Graphs from documents using LLM-powered extraction, provenance-native storage, and agent-callable tools.

Architecture

YOUR DOMAIN LAYER (Layer 2)
  Ontology, domain tools, agents-via-MCP
                    |
                    | imports
                    v
graphrag-core (Layer 1)

  Pipeline:        Ingest -> Extract -> Graph Store (+ L3 attestation)
                                            -> Search     (+ Entity Registry)

  Cross-cutting:   LLM Client  ·  Retrieval Models  ·  Tool Library (agent surface)

Install

pip install graphrag-core                    # core (in-memory backends)
pip install graphrag-core[neo4j]             # + Neo4j graph store and search
pip install graphrag-core[anthropic]         # + Claude LLM client
pip install graphrag-core[all]               # everything

Quick Start

import asyncio
from graphrag_core import (
    TextParser, TokenChunker, IngestionPipeline,
    InMemoryGraphStore, InMemorySearchEngine,
    LLMExtractionEngine, OntologySchema, NodeTypeDefinition,
    PropertyDefinition, RelationshipTypeDefinition,
    ToolLibrary, register_core_tools,
)
from graphrag_core.models import ChunkConfig, DocumentChunk, GraphNode, ImportRun
from datetime import datetime

async def main():
    # 1. Ingest a document
    pipeline = IngestionPipeline(parser=TextParser(), chunker=TokenChunker())
    chunks = await pipeline.ingest(b"Alice works at Acme Corp.", "text/plain")

    # 2. Define your domain schema
    schema = OntologySchema(
        node_types=[
            NodeTypeDefinition(
                label="Person",
                properties=[PropertyDefinition(name="name", type="string", required=True)],
                required_properties=["name"],
            ),
            NodeTypeDefinition(
                label="Company",
                properties=[PropertyDefinition(name="name", type="string", required=True)],
                required_properties=["name"],
            ),
        ],
        relationship_types=[
            RelationshipTypeDefinition(type="WORKS_AT", source_types=["Person"], target_types=["Company"]),
        ],
    )

    # 3. Extract entities (requires an LLMClient implementation)
    # engine = LLMExtractionEngine(llm_client=your_client)
    # result = await engine.extract(chunks, schema, import_run)

    # 4. Store in graph
    store = InMemoryGraphStore()
    await store.merge_node(GraphNode(id="p1", label="Person", properties={"name": "Alice"}), "run-1")
    await store.merge_node(GraphNode(id="c1", label="Company", properties={"name": "Acme Corp"}), "run-1")

    # 5. Search
    search = InMemorySearchEngine(
        nodes=[await store.get_node("p1"), await store.get_node("c1")],
    )
    results = await search.fulltext_search("Acme", top_k=5)
    print(results)

    # 6. Wire up tools for agents
    library = ToolLibrary()
    register_core_tools(library, store, search)
    result = await library.execute("get_entity", entity_id="p1")
    print(result)

asyncio.run(main())

Building Blocks

# Block Type Interface Default impls Status
1 Document Ingestion pipeline DocumentParser, Chunker, IngestionPipeline PDF/DOCX/Text/Markdown parsers; TokenChunker Done
2 Entity Extraction pipeline ExtractionEngine, ExtractionPromptBuilder, ExtractionPostProcessor LLMExtractionEngine, DefaultPromptBuilder Done
3 Knowledge Graph + Layer-3 attestation pipeline + doctrine GraphStore, CommunityDetector InMemoryGraphStore, Neo4jGraphStore Done
4 Hybrid Search pipeline SearchEngine InMemorySearchEngine, Neo4jHybridSearch (RRF) Done
5 Governed Curation retired merged into BB3 per ADR-0039 (doctrine in graph/INTERFACE.md) Retired
6 Entity Registry pipeline EntityRegistry InMemoryEntityRegistry (fuzzy + embedding match) Done
7 Tool Library (agent contract) cross-cutting Tool, ToolLibrary 4 core + 3 temporal tools Done
8 Orchestration retired deleted per ADR-0039; agent-callability = BB7 + MCP Retired
9 LLM Client cross-cutting LLMClient AnthropicLLMClient, OpenAILLMClient Done
10 Retrieval Models cross-cutting EmbeddingModel (+ Reranker planned) (BB10-01 in flight; see capability map) Designed

Extension Pattern

from graphrag_core import OntologySchema, ToolLibrary, Tool

# 1. Define your domain ontology
schema = OntologySchema(node_types=[...], relationship_types=[...])

# 2. Register domain-specific tools (the agent-callable surface — BB7)
library = ToolLibrary()
library.register(Tool(name="my_tool", description="...", parameters={}, handler=my_handler))

External agents (Claude Code, MCP clients, custom harnesses) consume your ToolLibrary over MCP — graphrag-core ships the tool contract; the agent harness is out-of-scope per the agentic-substrate doctrine.

Development

# Clone and install
git clone https://github.com/cdel1/graphrag-core.git
cd graphrag-core
uv sync --all-extras

# Run unit tests
uv run pytest tests/ -x -q

# Run integration tests (requires Neo4j)
docker run -d --name neo4j-test -p 7474:7474 -p 7687:7687 \
  -e NEO4J_AUTH=neo4j/development neo4j:5-community
uv run pytest tests/ -x --run-integration

# Build
uv build

License

The code in this repository is MIT-licensed — see LICENSE.

Data fixtures bundled under eval/fixtures/ retain their own licenses (DocRED is MIT; FEVEROUS is CC-BY-SA 3.0). See NOTICES.md for attribution and redistribution terms for each fixture.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphrag_core-0.13.0.tar.gz (263.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

graphrag_core-0.13.0-py3-none-any.whl (84.2 kB view details)

Uploaded Python 3

File details

Details for the file graphrag_core-0.13.0.tar.gz.

File metadata

  • Download URL: graphrag_core-0.13.0.tar.gz
  • Upload date:
  • Size: 263.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for graphrag_core-0.13.0.tar.gz
Algorithm Hash digest
SHA256 40f284e0d08d9d9ede59110579688bea3a579a06357ad3057c19476610d85906
MD5 aa832b564d964ee5fb7422a434787827
BLAKE2b-256 3a7228f890dd7dba86f1da652f5af9e88e6a22bbac19c0e5593fd2badb1b9aa8

See more details on using hashes here.

Provenance

The following attestation bundles were made for graphrag_core-0.13.0.tar.gz:

Publisher: release.yml on cdel1/graphrag-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file graphrag_core-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: graphrag_core-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 84.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for graphrag_core-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 56e7f2c7baa92b11c67ef005b70fbcfc7c9d331503f3e8c66b38df92c8f00977
MD5 87644e8a37b734a0b6dcd787c496c27f
BLAKE2b-256 983e8f76ee90a9a45b47b81e9759d6a7e306f1bb7c7cf478db2632e3e7b72c52

See more details on using hashes here.

Provenance

The following attestation bundles were made for graphrag_core-0.13.0-py3-none-any.whl:

Publisher: release.yml on cdel1/graphrag-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page