agentic-graphrag 0.0.4__tar.gz → 0.0.6__tar.gz

agentic_graphrag-0.0.6/PKG-INFO

@@ -0,0 +1,319 @@
+Metadata-Version: 2.4
+Name: agentic-graphrag
+Version: 0.0.6
+Summary: Context graphs that give AI agents memory they can trace to its sources.
+Keywords: agent-memory,context-graph,knowledge-graph,graphrag,ai-agents,mcp,neo4j,provenance
+Author: Ashwin Mathur, Varun Mathur
+Author-email: Ashwin Mathur <ashwinm400@gmail.com>, Varun Mathur <varunm500@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: chonkie>=1.7
+Requires-Dist: opentelemetry-api>=1.20
+Requires-Dist: openinference-semantic-conventions
+Requires-Dist: charset-normalizer>=3.4
+Requires-Dist: selectolax>=0.3.21,<1
+Requires-Dist: docling-slim[convert-core,format-markdown,format-html,format-docx,format-pptx,format-xlsx]>=2.135
+Requires-Dist: rapidfuzz>=3.0
+Requires-Dist: scipy>=1.14
+Requires-Dist: fastembed>=0.8.0
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: langgraph>=1.2 ; extra == 'agents'
+Requires-Dist: deepagents>=0.7.15 ; extra == 'agents'
+Requires-Dist: langchain-openai>=1.0 ; extra == 'agents'
+Requires-Dist: graspologic-native>=1.2.5 ; extra == 'community'
+Requires-Dist: docling>=2.135 ; extra == 'docling'
+Requires-Dist: sentence-transformers>=5 ; extra == 'embed-local'
+Requires-Dist: deepeval>=4.2.6 ; extra == 'eval'
+Requires-Dist: agentevals>=0.0.9 ; extra == 'eval'
+Requires-Dist: er-evaluation>=2.3.0 ; extra == 'eval'
+Requires-Dist: scikit-learn>=1.5 ; extra == 'eval'
+Requires-Dist: langchain-openai>=1.0 ; extra == 'eval'
+Requires-Dist: opentelemetry-sdk>=1.20 ; extra == 'eval'
+Requires-Dist: openinference-instrumentation-langchain>=0.1.76,<0.2 ; extra == 'eval'
+Requires-Dist: gliner2[local] ; extra == 'extract'
+Requires-Dist: transformers<4.56 ; extra == 'extract'
+Requires-Dist: protobuf ; extra == 'extract'
+Requires-Dist: baml-py>=0.226.1,<0.227 ; extra == 'llm'
+Requires-Dist: mcp>=2.3,<3 ; extra == 'mcp'
+Requires-Dist: neo4j>=5.22 ; extra == 'neo4j'
+Requires-Dist: opentelemetry-sdk>=1.20 ; extra == 'observability'
+Requires-Dist: opentelemetry-exporter-otlp>=1.20 ; extra == 'observability'
+Requires-Dist: opentelemetry-instrumentation-asyncio ; extra == 'observability'
+Requires-Dist: openinference-instrumentation-langchain>=0.1.76,<0.2 ; extra == 'observability'
+Requires-Dist: rdflib>=7.1 ; extra == 'schema-formats'
+Maintainer: Ashwin Mathur, Varun Mathur
+Maintainer-email: Ashwin Mathur <ashwinm400@gmail.com>, Varun Mathur <varunm500@gmail.com>
+Requires-Python: >=3.11
+Project-URL: Documentation, https://ontogr.github.io/agentic-graphrag/
+Project-URL: Issues, https://github.com/ontogr/agentic-graphrag/issues
+Project-URL: Source, https://github.com/ontogr/agentic-graphrag
+Provides-Extra: agents
+Provides-Extra: community
+Provides-Extra: docling
+Provides-Extra: embed-local
+Provides-Extra: eval
+Provides-Extra: extract
+Provides-Extra: llm
+Provides-Extra: mcp
+Provides-Extra: neo4j
+Provides-Extra: observability
+Provides-Extra: schema-formats
+Description-Content-Type: text/markdown
+
+<h1 align="center"><a href="https://github.com/ontogr/agentic-graphrag">Agentic GraphRAG</a></h1>
+
+<h3 align="center">Context graphs that give AI agents memory they can trace to its sources.</h3>
+<h4 align="center"><a href="https://ontogr.github.io/agentic-graphrag/">Documentation</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/get-started/quickstart">Quickstart</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/concepts/architecture">Concepts</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/guides/ingest-documents">Guides</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/api/">API reference</a></h4>
+
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/agentic-graphrag.svg)](https://pypi.org/project/agentic-graphrag/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://pypi.org/project/agentic-graphrag/)
+[![Downloads](https://static.pepy.tech/badge/agentic-graphrag)](https://pepy.tech/project/agentic-graphrag)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue?logo=readthedocs)](https://ontogr.github.io/agentic-graphrag/)
+[![DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ontogr/agentic-graphrag)
+[![License](https://img.shields.io/github/license/ontogr/agentic-graphrag?color=green)](https://github.com/ontogr/agentic-graphrag/blob/main/LICENSE)
+
+</div>
+
+<div align="center">
+
+[![CI](https://img.shields.io/github/actions/workflow/status/ontogr/agentic-graphrag/ci.yml?branch=main&label=CI&logo=githubactions)](https://github.com/ontogr/agentic-graphrag/actions/workflows/ci.yml)
+[![Integration tests](https://img.shields.io/github/actions/workflow/status/ontogr/agentic-graphrag/integration.yml?branch=main&label=integration%20tests&logo=pytest)](https://github.com/ontogr/agentic-graphrag/actions/workflows/integration.yml)
+[![Codecov](https://codecov.io/gh/ontogr/agentic-graphrag/branch/main/graph/badge.svg)](https://codecov.io/gh/ontogr/agentic-graphrag)
+
+</div>
+
+Agentic GraphRAG is an open source Python framework that connects your documents, agent activity, and decisions in one graph. Your agents can find evidence, continue work across sessions, and revisit decisions when their sources change.
+
+Turn documents into searchable knowledge shaped by your own schema. Give agents tools to follow relationships, read source passages, and cite what they use. Keep decisions linked to the evidence behind them. Use the Python library, connect your agent through MCP, or start with the built-in agent.
+
+For example, a contract-review agent can record a recommendation with passages from a contract and a policy. A later session retrieves the task and its decision. When the policy changes, the decision is flagged for review against the new evidence.
+
+## Features
+
+### One graph for documents, tasks, and decisions
+
+Documents, agent work, and decisions live together, so every answer can be traced back to its source.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/graph3d.png" alt="Three stacked graph layers. Enterprise knowledge holds documents, sections, chunks and entities. Conversation history holds tasks, events and steps. Decision traces point up to the passages and events they rely on." width="860">
+</p>
+
+- **Three connected layers.** The first layer holds your documents, with their sections, tables, and passages, and the people, organizations, products, and other entities found in them. The second holds named tasks, the steps agents take, and a log of what happened. The third holds the decisions agents make.
+- **Every passage knows where it came from.** A passage records its document, its place in the document's structure, and the exact version it came from, with page positions for PDFs.
+- **Relations can point to their evidence.** A relation links to the passages that support it when evidence exists, and a decision links to the text it was based on.
+- **Old citations keep working.** The graph keeps the history of each document, so a citation to an older version still leads to the text that was cited.
+
+### Build the graph around your own schema
+
+You decide which things matter, and the graph is built around them.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/schema-pipeline.png" alt="Extraction reads each chunk with a local model, sends uncertain chunks to an LLM, and checks the result against your schema. Entities and relationships outside the schema are saved for review. Resolution then compares entities in steps, from cheap checks to an LLM, and stores each match as a link." width="860">
+</p>
+
+- **Describe your own entities and relations.** Name the kinds of things that matter to you, such as people, contracts, or products, and the relations between them. Write the schema in code or in a configuration file, or start from a ready-made preset and extend it.
+- **Extraction runs on your machine first.** You can build a graph without an LLM. When the local model is unsure about a passage, an LLM can read it, and you decide how much of each batch the LLM may read.
+- **Nothing outside your schema is lost.** Anything the models find that your schema does not cover is saved for review. Approved items become part of your schema and your graph.
+- **Duplicates are merged with care.** Agentic GraphRAG recognizes that "Acme Corp" and "Acme Corporation" are the same company. It starts with cheap checks and asks an LLM only about the pairs that remain unclear.
+- **Every match can be undone.** A match is stored as a link between two entities, so the originals stay in the graph. You can preview a cleanup of the whole graph before you apply it.
+
+### Search your documents and read the evidence
+
+Agents find passages, read the exact text, and move around a document the way a person would.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/search-evidence.png" alt="A query runs full-text, semantic, or hybrid search over the chunks of the documents you allow. Hits carry evidence ids, and a fetch returns the exact passage text with a citation. Optional steps navigate the document tree, search entities, and explore relationships." width="860">
+</p>
+
+- **Full-text, semantic, and hybrid search.** Full-text search matches keywords, semantic search compares embeddings, and hybrid search fuses both rankings with reciprocal rank fusion. A search returns short previews, each with an evidence id for its passage, and a separate step fetches the exact text.
+- **You set the boundary outside the model.** You decide which documents an agent may read, and the model can only work inside that choice.
+- **Source text stays findable.** Search reads the passages directly, so a passage is still found when extraction missed the fact it contains.
+- **Move around a passage.** From any passage, an agent can reach the surrounding section, the neighboring passages, or the rows around a table cell, which keep their column headers.
+- **Follow entities back to text.** An agent can look up an entity, see the passages that mention it, and follow its relations a few steps out. Each relation is marked as backed by a passage or as a connection without direct text.
+- **Incomplete results say so.** Every result states when something was cut off or part of the search failed, so an incomplete result is never mistaken for an empty one.
+
+### Remember tasks and decisions
+
+The memory layer records an agent's work and decisions as it runs, keeps them current when sources change, and recalls them to inform later decisions.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/task-resume.png" alt="The agent records events, steps, and decisions in the memory layer as it works. A decision cites passages, events, and earlier decisions. When a cited document changes, the decision is flagged for review. The agent recalls the task and searches past decisions to inform new ones." width="860">
+</p>
+
+- **Work is recorded as it happens.** The built-in agent saves each message, tool call, and tool result as a task event, and it tracks progress as steps. Repeating a write after a failure never records it twice.
+- **Decisions are saved as traces.** A decision records a conclusion, the reasoning, the assumptions, and the open questions, along with the passages, events, or earlier decisions it relies on.
+- **Source changes flag decisions.** When a document behind a decision is updated or removed, the decision is flagged for review, and so are the decisions that depend on it.
+- **Reviews end in a clear action.** A reviewer can reaffirm a decision after reading the current text, or replace it with a new one that explains the change. The earlier version stays in the history.
+- **Tasks resume with the full picture.** When a task resumes, the agent sees the goal, the progress so far, and the decisions already made, including any that need review. It reuses finished work that is still valid, and a step that was interrupted is marked as unknown so that it can be run again.
+- **Past decisions inform new ones.** Agents can search earlier decisions in the same project. The built-in agent's search leaves out decisions that need review, and the agent cannot cite one as support.
+
+### Use the built-in agent or any MCP client
+
+Use the agent that ships with the library, or connect your own through MCP.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/full-flow.png" alt="Documents are loaded, chunked, extracted, and resolved into a graph with three layers: enterprise knowledge, conversation history, and decision traces. A changed document flags the decisions that cite it. An agent searches and reads the graph and records its events, steps, and decisions. Its answer passes a citation check and returns with numbered sources." width="860">
+</p>
+
+- **Answers cite numbered sources.** The built-in agent searches your documents, reads passages, and answers with numbered sources.
+- **Every citation is checked.** The passage must have been read during that run, it must belong to the documents the agent may use, and it must match the version cited. If a citation fails the check, the agent gets one chance to fix it.
+- **Every run ends with a status.** The status tells you whether the agent answered, found too little evidence, or reached a limit. You set how many steps and tool calls a run may use.
+- **Choose your model.** Use Anthropic, OpenAI, Google, or any OpenAI-compatible model, with fallback between them.
+- **The same tools work through MCP.** A local MCP server gives other agents the same tools. It starts read-only and shows only the documents you choose, and you decide whether a client may record tasks and decisions.
+- **Trace and evaluate your runs.** Runs can be traced with OpenTelemetry, and the evaluation tools score answers, citations, and agent runs on your own questions.
+
+See the [features page](https://ontogr.github.io/agentic-graphrag/stable/get-started/features) for the complete list, including supported file formats, chunking, keeping the graph current as documents change, and community summaries.
+
+## Quickstart
+
+In this example you add one document, ask a question about it, and get an answer with numbered sources. You need Python 3.11 or newer, a running Neo4j database, and an OpenAI-compatible LLM endpoint. See the [quickstart guide](https://ontogr.github.io/agentic-graphrag/stable/get-started/quickstart) for starting Neo4j with Docker or Neo4j Aura.
+
+### 1. Install
+
+Install the package from PyPI into a fresh virtual environment:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv pip install "agentic-graphrag[neo4j,extract,agents]" --torch-backend=auto
+```
+
+See [Installation](https://ontogr.github.io/agentic-graphrag/stable/get-started/installation) for other package managers and the optional parts you can add.
+
+### 2. Add your settings
+
+Create a file named `.env` in the folder where you will run the example. Replace the values with your own, and keep the file out of version control.
+
+```dotenv
+NEO4J_URI=bolt://localhost:7687
+NEO4J_USERNAME=neo4j
+NEO4J_PASSWORD=your-neo4j-password
+AGENT_LLM_BASE_URL=https://your-endpoint.example.com/v1
+AGENT_LLM_API_KEY=your-api-key
+AGENT_LLM_MODEL_ID=your-model-id
+```
+
+The last three lines are the address, key, and model of your OpenAI-compatible LLM endpoint. For a Neo4j database on another machine, see [Configuration](https://ontogr.github.io/agentic-graphrag/stable/reference/configuration).
+
+### 3. Run the example
+
+Put any Markdown or text file in the same folder and name it `your-document.md`. Save the following as `example.py` and run `python example.py`.
+
+```python
+import asyncio
+from pathlib import Path
+
+from agrag.agents import AgentLLMSettings, build_agent
+from agrag.embedding import build_embedder
+from agrag.graphdb import build_graph_store
+from agrag.ingestion import ExtractionSettings, Graph
+
+# Any Markdown or text file you have.
+DOCUMENT = Path("your-document.md").resolve()
+
+
+async def main() -> None:
+    # Connect to the database and load the model that turns text into vectors.
+    store = build_graph_store("neo4j")
+    embedder = build_embedder("ibm-granite/granite-embedding-small-english-r2")
+    try:
+        # Read the document into the graph. This step runs on your machine.
+        graph = await Graph.open(
+            schema="operations",
+            graph_store=store,
+            embedder=embedder,
+            extraction_settings=ExtractionSettings(mode="gliner"),
+            max_llm_pairs=0,
+        )
+        await graph.add(DOCUMENT)
+
+        # Create an agent that may read only this document.
+        agent = build_agent(
+            graph_store=store,
+            embedder=embedder,
+            scope=frozenset({str(DOCUMENT)}),
+            project_id="my-project",
+            agent_id="researcher",
+            llm_settings=AgentLLMSettings.from_openai_compatible_env(),
+        )
+
+        # Ask a question about the document.
+        result = await agent.ainvoke({
+            "task_name": "first-question",
+            "question": "What are the main points of this document? Cite your sources.",
+        })
+        print(result["answer"])
+    finally:
+        await store.close()
+
+
+asyncio.run(main())
+```
+
+The script prints an answer that ends with a numbered list of sources. Run it again with the same task name and the agent continues where it stopped.
+
+### Next steps
+
+- See [Record decisions and review them](https://ontogr.github.io/agentic-graphrag/stable/guides/connected-memory) for tying a decision to its evidence and reviewing it when a document changes.
+- See [Find and cite evidence](https://ontogr.github.io/agentic-graphrag/stable/guides/find-and-cite-evidence) for searching passages and checking citations from your own code.
+- See the [features page](https://ontogr.github.io/agentic-graphrag/stable/get-started/features) for everything else Agentic GraphRAG does.
+
+## Use MCP
+
+Run `agrag-mcp` to give any MCP client tools that search your documents, read exact passages, check citations, and keep task and decision memory.
+
+Install the server in the same virtual environment as before:
+
+```bash
+uv pip install "agentic-graphrag[neo4j,mcp]"
+```
+
+Then add the server to your MCP client. Replace the document path with the full path of a file you added to the graph.
+
+```json
+{
+  "mcpServers": {
+    "agrag": {
+      "command": "agrag-mcp",
+      "env": {
+        "NEO4J_URI": "bolt://localhost:7687",
+        "NEO4J_USERNAME": "neo4j",
+        "NEO4J_PASSWORD": "your-neo4j-password",
+        "AGRAG_MCP_SCOPE_DOCUMENT_KEYS": "/full/path/to/your-document.md",
+        "AGRAG_MCP_PROJECT_ID": "my-project",
+        "AGRAG_MCP_AGENT_ID": "researcher"
+      }
+    }
+  }
+}
+```
+
+If your client cannot find `agrag-mcp`, use its full path inside the virtual environment, for example `/full/path/to/.venv/bin/agrag-mcp`. The server starts read-only and reads only the documents you list. The project and agent IDs enable task and decision memory tools; writes remain disabled until you change the server settings. See the [MCP server guide](https://ontogr.github.io/agentic-graphrag/stable/guides/run-the-mcp-server) for the other settings.
+
+## Contributing
+
+We welcome bug fixes, new features, documentation improvements, and other contributions. Please read our [Contributing guide](CONTRIBUTING.md) before submitting a pull request.
+
+## Acknowledgements
+
+Agentic GraphRAG builds on the work behind these papers and projects.
+
+- [Graphiti](https://github.com/getzep/graphiti) for layered graph search and entity-aware retrieval
+- [Cognee](https://github.com/topoteretes/cognee) for data pipelines, graph memory, and consolidation
+- [FalkorDB GraphRAG SDK](https://github.com/FalkorDB/GraphRAG-SDK) for graph-native retrieval and entity resolution
+- [Neo4j GraphRAG](https://github.com/neo4j/neo4j-graphrag-python) for Neo4j retrieval and vector integration
+- [GLiNER](https://arxiv.org/abs/2311.08526) for generalist zero-shot information extraction
+- [BAML](https://boundaryml.com/), [Docling](https://github.com/docling-project/docling), and [Chonkie](https://github.com/chonkie-inc/chonkie) for typed LLM calls, document parsing, and chunk splitting
+
+## License
+
+Agentic GraphRAG is licensed under the [Apache License 2.0](https://github.com/ontogr/agentic-graphrag/blob/main/LICENSE).

agentic_graphrag-0.0.6/README.md

@@ -0,0 +1,251 @@
+<h1 align="center"><a href="https://github.com/ontogr/agentic-graphrag">Agentic GraphRAG</a></h1>
+
+<h3 align="center">Context graphs that give AI agents memory they can trace to its sources.</h3>
+<h4 align="center"><a href="https://ontogr.github.io/agentic-graphrag/">Documentation</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/get-started/quickstart">Quickstart</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/concepts/architecture">Concepts</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/guides/ingest-documents">Guides</a> · <a href="https://ontogr.github.io/agentic-graphrag/stable/api/">API reference</a></h4>
+
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/agentic-graphrag.svg)](https://pypi.org/project/agentic-graphrag/)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://pypi.org/project/agentic-graphrag/)
+[![Downloads](https://static.pepy.tech/badge/agentic-graphrag)](https://pepy.tech/project/agentic-graphrag)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue?logo=readthedocs)](https://ontogr.github.io/agentic-graphrag/)
+[![DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ontogr/agentic-graphrag)
+[![License](https://img.shields.io/github/license/ontogr/agentic-graphrag?color=green)](https://github.com/ontogr/agentic-graphrag/blob/main/LICENSE)
+
+</div>
+
+<div align="center">
+
+[![CI](https://img.shields.io/github/actions/workflow/status/ontogr/agentic-graphrag/ci.yml?branch=main&label=CI&logo=githubactions)](https://github.com/ontogr/agentic-graphrag/actions/workflows/ci.yml)
+[![Integration tests](https://img.shields.io/github/actions/workflow/status/ontogr/agentic-graphrag/integration.yml?branch=main&label=integration%20tests&logo=pytest)](https://github.com/ontogr/agentic-graphrag/actions/workflows/integration.yml)
+[![Codecov](https://codecov.io/gh/ontogr/agentic-graphrag/branch/main/graph/badge.svg)](https://codecov.io/gh/ontogr/agentic-graphrag)
+
+</div>
+
+Agentic GraphRAG is an open source Python framework that connects your documents, agent activity, and decisions in one graph. Your agents can find evidence, continue work across sessions, and revisit decisions when their sources change.
+
+Turn documents into searchable knowledge shaped by your own schema. Give agents tools to follow relationships, read source passages, and cite what they use. Keep decisions linked to the evidence behind them. Use the Python library, connect your agent through MCP, or start with the built-in agent.
+
+For example, a contract-review agent can record a recommendation with passages from a contract and a policy. A later session retrieves the task and its decision. When the policy changes, the decision is flagged for review against the new evidence.
+
+## Features
+
+### One graph for documents, tasks, and decisions
+
+Documents, agent work, and decisions live together, so every answer can be traced back to its source.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/graph3d.png" alt="Three stacked graph layers. Enterprise knowledge holds documents, sections, chunks and entities. Conversation history holds tasks, events and steps. Decision traces point up to the passages and events they rely on." width="860">
+</p>
+
+- **Three connected layers.** The first layer holds your documents, with their sections, tables, and passages, and the people, organizations, products, and other entities found in them. The second holds named tasks, the steps agents take, and a log of what happened. The third holds the decisions agents make.
+- **Every passage knows where it came from.** A passage records its document, its place in the document's structure, and the exact version it came from, with page positions for PDFs.
+- **Relations can point to their evidence.** A relation links to the passages that support it when evidence exists, and a decision links to the text it was based on.
+- **Old citations keep working.** The graph keeps the history of each document, so a citation to an older version still leads to the text that was cited.
+
+### Build the graph around your own schema
+
+You decide which things matter, and the graph is built around them.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/schema-pipeline.png" alt="Extraction reads each chunk with a local model, sends uncertain chunks to an LLM, and checks the result against your schema. Entities and relationships outside the schema are saved for review. Resolution then compares entities in steps, from cheap checks to an LLM, and stores each match as a link." width="860">
+</p>
+
+- **Describe your own entities and relations.** Name the kinds of things that matter to you, such as people, contracts, or products, and the relations between them. Write the schema in code or in a configuration file, or start from a ready-made preset and extend it.
+- **Extraction runs on your machine first.** You can build a graph without an LLM. When the local model is unsure about a passage, an LLM can read it, and you decide how much of each batch the LLM may read.
+- **Nothing outside your schema is lost.** Anything the models find that your schema does not cover is saved for review. Approved items become part of your schema and your graph.
+- **Duplicates are merged with care.** Agentic GraphRAG recognizes that "Acme Corp" and "Acme Corporation" are the same company. It starts with cheap checks and asks an LLM only about the pairs that remain unclear.
+- **Every match can be undone.** A match is stored as a link between two entities, so the originals stay in the graph. You can preview a cleanup of the whole graph before you apply it.
+
+### Search your documents and read the evidence
+
+Agents find passages, read the exact text, and move around a document the way a person would.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/search-evidence.png" alt="A query runs full-text, semantic, or hybrid search over the chunks of the documents you allow. Hits carry evidence ids, and a fetch returns the exact passage text with a citation. Optional steps navigate the document tree, search entities, and explore relationships." width="860">
+</p>
+
+- **Full-text, semantic, and hybrid search.** Full-text search matches keywords, semantic search compares embeddings, and hybrid search fuses both rankings with reciprocal rank fusion. A search returns short previews, each with an evidence id for its passage, and a separate step fetches the exact text.
+- **You set the boundary outside the model.** You decide which documents an agent may read, and the model can only work inside that choice.
+- **Source text stays findable.** Search reads the passages directly, so a passage is still found when extraction missed the fact it contains.
+- **Move around a passage.** From any passage, an agent can reach the surrounding section, the neighboring passages, or the rows around a table cell, which keep their column headers.
+- **Follow entities back to text.** An agent can look up an entity, see the passages that mention it, and follow its relations a few steps out. Each relation is marked as backed by a passage or as a connection without direct text.
+- **Incomplete results say so.** Every result states when something was cut off or part of the search failed, so an incomplete result is never mistaken for an empty one.
+
+### Remember tasks and decisions
+
+The memory layer records an agent's work and decisions as it runs, keeps them current when sources change, and recalls them to inform later decisions.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/task-resume.png" alt="The agent records events, steps, and decisions in the memory layer as it works. A decision cites passages, events, and earlier decisions. When a cited document changes, the decision is flagged for review. The agent recalls the task and searches past decisions to inform new ones." width="860">
+</p>
+
+- **Work is recorded as it happens.** The built-in agent saves each message, tool call, and tool result as a task event, and it tracks progress as steps. Repeating a write after a failure never records it twice.
+- **Decisions are saved as traces.** A decision records a conclusion, the reasoning, the assumptions, and the open questions, along with the passages, events, or earlier decisions it relies on.
+- **Source changes flag decisions.** When a document behind a decision is updated or removed, the decision is flagged for review, and so are the decisions that depend on it.
+- **Reviews end in a clear action.** A reviewer can reaffirm a decision after reading the current text, or replace it with a new one that explains the change. The earlier version stays in the history.
+- **Tasks resume with the full picture.** When a task resumes, the agent sees the goal, the progress so far, and the decisions already made, including any that need review. It reuses finished work that is still valid, and a step that was interrupted is marked as unknown so that it can be run again.
+- **Past decisions inform new ones.** Agents can search earlier decisions in the same project. The built-in agent's search leaves out decisions that need review, and the agent cannot cite one as support.
+
+### Use the built-in agent or any MCP client
+
+Use the agent that ships with the library, or connect your own through MCP.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ontogr/agentic-graphrag/main/docs/static/img/readme/full-flow.png" alt="Documents are loaded, chunked, extracted, and resolved into a graph with three layers: enterprise knowledge, conversation history, and decision traces. A changed document flags the decisions that cite it. An agent searches and reads the graph and records its events, steps, and decisions. Its answer passes a citation check and returns with numbered sources." width="860">
+</p>
+
+- **Answers cite numbered sources.** The built-in agent searches your documents, reads passages, and answers with numbered sources.
+- **Every citation is checked.** The passage must have been read during that run, it must belong to the documents the agent may use, and it must match the version cited. If a citation fails the check, the agent gets one chance to fix it.
+- **Every run ends with a status.** The status tells you whether the agent answered, found too little evidence, or reached a limit. You set how many steps and tool calls a run may use.
+- **Choose your model.** Use Anthropic, OpenAI, Google, or any OpenAI-compatible model, with fallback between them.
+- **The same tools work through MCP.** A local MCP server gives other agents the same tools. It starts read-only and shows only the documents you choose, and you decide whether a client may record tasks and decisions.
+- **Trace and evaluate your runs.** Runs can be traced with OpenTelemetry, and the evaluation tools score answers, citations, and agent runs on your own questions.
+
+See the [features page](https://ontogr.github.io/agentic-graphrag/stable/get-started/features) for the complete list, including supported file formats, chunking, keeping the graph current as documents change, and community summaries.
+
+## Quickstart
+
+In this example you add one document, ask a question about it, and get an answer with numbered sources. You need Python 3.11 or newer, a running Neo4j database, and an OpenAI-compatible LLM endpoint. See the [quickstart guide](https://ontogr.github.io/agentic-graphrag/stable/get-started/quickstart) for starting Neo4j with Docker or Neo4j Aura.
+
+### 1. Install
+
+Install the package from PyPI into a fresh virtual environment:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv pip install "agentic-graphrag[neo4j,extract,agents]" --torch-backend=auto
+```
+
+See [Installation](https://ontogr.github.io/agentic-graphrag/stable/get-started/installation) for other package managers and the optional parts you can add.
+
+### 2. Add your settings
+
+Create a file named `.env` in the folder where you will run the example. Replace the values with your own, and keep the file out of version control.
+
+```dotenv
+NEO4J_URI=bolt://localhost:7687
+NEO4J_USERNAME=neo4j
+NEO4J_PASSWORD=your-neo4j-password
+AGENT_LLM_BASE_URL=https://your-endpoint.example.com/v1
+AGENT_LLM_API_KEY=your-api-key
+AGENT_LLM_MODEL_ID=your-model-id
+```
+
+The last three lines are the address, key, and model of your OpenAI-compatible LLM endpoint. For a Neo4j database on another machine, see [Configuration](https://ontogr.github.io/agentic-graphrag/stable/reference/configuration).
+
+### 3. Run the example
+
+Put any Markdown or text file in the same folder and name it `your-document.md`. Save the following as `example.py` and run `python example.py`.
+
+```python
+import asyncio
+from pathlib import Path
+
+from agrag.agents import AgentLLMSettings, build_agent
+from agrag.embedding import build_embedder
+from agrag.graphdb import build_graph_store
+from agrag.ingestion import ExtractionSettings, Graph
+
+# Any Markdown or text file you have.
+DOCUMENT = Path("your-document.md").resolve()
+
+
+async def main() -> None:
+    # Connect to the database and load the model that turns text into vectors.
+    store = build_graph_store("neo4j")
+    embedder = build_embedder("ibm-granite/granite-embedding-small-english-r2")
+    try:
+        # Read the document into the graph. This step runs on your machine.
+        graph = await Graph.open(
+            schema="operations",
+            graph_store=store,
+            embedder=embedder,
+            extraction_settings=ExtractionSettings(mode="gliner"),
+            max_llm_pairs=0,
+        )
+        await graph.add(DOCUMENT)
+
+        # Create an agent that may read only this document.
+        agent = build_agent(
+            graph_store=store,
+            embedder=embedder,
+            scope=frozenset({str(DOCUMENT)}),
+            project_id="my-project",
+            agent_id="researcher",
+            llm_settings=AgentLLMSettings.from_openai_compatible_env(),
+        )
+
+        # Ask a question about the document.
+        result = await agent.ainvoke({
+            "task_name": "first-question",
+            "question": "What are the main points of this document? Cite your sources.",
+        })
+        print(result["answer"])
+    finally:
+        await store.close()
+
+
+asyncio.run(main())
+```
+
+The script prints an answer that ends with a numbered list of sources. Run it again with the same task name and the agent continues where it stopped.
+
+### Next steps
+
+- See [Record decisions and review them](https://ontogr.github.io/agentic-graphrag/stable/guides/connected-memory) for tying a decision to its evidence and reviewing it when a document changes.
+- See [Find and cite evidence](https://ontogr.github.io/agentic-graphrag/stable/guides/find-and-cite-evidence) for searching passages and checking citations from your own code.
+- See the [features page](https://ontogr.github.io/agentic-graphrag/stable/get-started/features) for everything else Agentic GraphRAG does.
+
+## Use MCP
+
+Run `agrag-mcp` to give any MCP client tools that search your documents, read exact passages, check citations, and keep task and decision memory.
+
+Install the server in the same virtual environment as before:
+
+```bash
+uv pip install "agentic-graphrag[neo4j,mcp]"
+```
+
+Then add the server to your MCP client. Replace the document path with the full path of a file you added to the graph.
+
+```json
+{
+  "mcpServers": {
+    "agrag": {
+      "command": "agrag-mcp",
+      "env": {
+        "NEO4J_URI": "bolt://localhost:7687",
+        "NEO4J_USERNAME": "neo4j",
+        "NEO4J_PASSWORD": "your-neo4j-password",
+        "AGRAG_MCP_SCOPE_DOCUMENT_KEYS": "/full/path/to/your-document.md",
+        "AGRAG_MCP_PROJECT_ID": "my-project",
+        "AGRAG_MCP_AGENT_ID": "researcher"
+      }
+    }
+  }
+}
+```
+
+If your client cannot find `agrag-mcp`, use its full path inside the virtual environment, for example `/full/path/to/.venv/bin/agrag-mcp`. The server starts read-only and reads only the documents you list. The project and agent IDs enable task and decision memory tools; writes remain disabled until you change the server settings. See the [MCP server guide](https://ontogr.github.io/agentic-graphrag/stable/guides/run-the-mcp-server) for the other settings.
+
+## Contributing
+
+We welcome bug fixes, new features, documentation improvements, and other contributions. Please read our [Contributing guide](CONTRIBUTING.md) before submitting a pull request.
+
+## Acknowledgements
+
+Agentic GraphRAG builds on the work behind these papers and projects.
+
+- [Graphiti](https://github.com/getzep/graphiti) for layered graph search and entity-aware retrieval
+- [Cognee](https://github.com/topoteretes/cognee) for data pipelines, graph memory, and consolidation
+- [FalkorDB GraphRAG SDK](https://github.com/FalkorDB/GraphRAG-SDK) for graph-native retrieval and entity resolution
+- [Neo4j GraphRAG](https://github.com/neo4j/neo4j-graphrag-python) for Neo4j retrieval and vector integration
+- [GLiNER](https://arxiv.org/abs/2311.08526) for generalist zero-shot information extraction
+- [BAML](https://boundaryml.com/), [Docling](https://github.com/docling-project/docling), and [Chonkie](https://github.com/chonkie-inc/chonkie) for typed LLM calls, document parsing, and chunk splitting
+
+## License
+
+Agentic GraphRAG is licensed under the [Apache License 2.0](https://github.com/ontogr/agentic-graphrag/blob/main/LICENSE).

agentic_graphrag-0.0.6/agrag/agents/__init__.py

@@ -0,0 +1,36 @@
+"""Agentic layer: one task-scoped evidence agent over the graph.
+
+``build_agent`` is imported lazily because it needs the optional ``agents``
+extra. Importing this package does not require that extra.
+"""
+
+from typing import TYPE_CHECKING, Any
+
+from agrag.agents.errors import AgentMissingExtraError
+from agrag.agents.ledger import Ledger
+from agrag.agents.result import AgentRunResult
+from agrag.agents.settings import AgentLLMSettings, AgentSettings
+
+
+if TYPE_CHECKING:
+    from agrag.agents.build import build_agent
+
+
+def __getattr__(name: str) -> Any:
+    """Load the optional agent builder when a caller requests it."""
+    if name != "build_agent":
+        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+    from agrag.agents.build import build_agent  # noqa: PLC0415
+
+    return build_agent
+
+
+__all__ = [
+    "AgentLLMSettings",
+    "AgentMissingExtraError",
+    "AgentRunResult",
+    "AgentSettings",
+    "Ledger",
+    "build_agent",
+]