A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
Dayenne Souza 74ad1d4a0c
Some checks failed
gh-pages / build (push) Has been cancelled
Python CI / python-ci (ubuntu-latest, 3.10) (push) Has been cancelled
Python CI / python-ci (ubuntu-latest, 3.11) (push) Has been cancelled
Python CI / python-ci (windows-latest, 3.10) (push) Has been cancelled
Python CI / python-ci (windows-latest, 3.11) (push) Has been cancelled
Python Integration Tests / python-ci (ubuntu-latest, 3.10) (push) Has been cancelled
Python Integration Tests / python-ci (windows-latest, 3.10) (push) Has been cancelled
Python Notebook Tests / python-ci (ubuntu-latest, 3.10) (push) Has been cancelled
Python Notebook Tests / python-ci (windows-latest, 3.10) (push) Has been cancelled
Python Publish (pypi) / Upload release to PyPI (push) Has been cancelled
Python Smoke Tests / python-ci (ubuntu-latest, 3.10) (push) Has been cancelled
Python Smoke Tests / python-ci (windows-latest, 3.10) (push) Has been cancelled
Spellcheck / spellcheck (push) Has been cancelled
Update .vsts-ci.yml (#1874)
2025-04-10 10:31:03 -06:00
.github Fix API key reference for gh-pages (#1821) 2025-03-18 11:10:11 -07:00
.semversioner Vector Store Integration Tests (#1856) 2025-04-01 11:05:04 -04:00
.vscode Feat/update cli (#1376) 2024-11-07 06:59:10 -06:00
docs Update config docs (2.1.0) (#1818) 2025-03-18 12:39:30 -07:00
examples_notebooks Cleanup query api - remove code duplication (#1690) 2025-02-13 16:31:08 -05:00
graphrag Vector Store Integration Tests (#1856) 2025-04-01 11:05:04 -04:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests Vector Store Integration Tests (#1856) 2025-04-01 11:05:04 -04:00
unified-search-app Update .vsts-ci.yml (#1874) 2025-04-10 10:31:03 -06:00
.gitattributes move mkdocs-typer to devdeps (#1331) 2024-10-30 14:49:30 -07:00
.gitignore Fix/notebooks (#1614) 2025-01-13 17:41:39 -06:00
.vsts-ci.yml Initial Release 2024-07-01 15:25:30 -06:00
breaking-changes.md Next release docs (#1627) 2025-03-03 14:46:00 -08:00
CHANGELOG.md Release v2.1.0 (#1800) 2025-03-11 18:16:08 -06:00
CODE_OF_CONDUCT.md Initial Release 2024-07-01 15:25:30 -06:00
CODEOWNERS Stabilize smoke tests for query community context building (#908) 2024-08-12 13:17:40 -06:00
CONTRIBUTING.md Initial Release 2024-07-01 15:25:30 -06:00
cspell.config.yaml Fix/notebooks (#1614) 2025-01-13 17:41:39 -06:00
DEVELOPING.md Fix typo in DEVELOPING.md instructions (#1631) 2025-02-04 13:16:57 -08:00
dictionary.txt Unified search added to graphrag (#1862) 2025-04-07 11:59:02 -06:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
mkdocs.yaml Add docs page about input formats (#1784) 2025-03-11 17:37:46 -07:00
poetry.lock fnllm version fix (#1835) 2025-03-21 22:13:56 -07:00
pyproject.toml fnllm version fix (#1835) 2025-03-21 22:13:56 -07:00
RAI_TRANSPARENCY.md Initial Release 2024-07-01 15:25:30 -06:00
README.md Next release docs (#1627) 2025-03-03 14:46:00 -08:00
SECURITY.md Initial Release 2024-07-01 15:25:30 -06:00
SUPPORT.md Initial Release 2024-07-01 15:25:30 -06:00

GraphRAG

👉 Use the GraphRAG Accelerator solution
👉 Microsoft Research Blog Post
👉 Read the docs
👉 GraphRAG Arxiv

Overview

The GraphRAG project is a data pipeline and transformation suite that is designed to extract meaningful, structured data from unstructured text using the power of LLMs.

To learn more about GraphRAG and how it can be used to enhance your LLM's ability to reason about your private data, please visit the Microsoft Research Blog Post.

Quickstart

To get started with the GraphRAG system we recommend trying the Solution Accelerator package. This provides a user-friendly end-to-end experience with Azure resources.

Repository Guidance

This repository presents a methodology for using knowledge graph memory structures to enhance LLM outputs. Please note that the provided code serves as a demonstration and is not an officially supported Microsoft offering.

⚠️ Warning: GraphRAG indexing can be an expensive operation, please read all of the documentation to understand the process and costs involved, and start small.

Diving Deeper

Prompt Tuning

Using GraphRAG with your data out of the box may not yield the best possible results. We strongly recommend to fine-tune your prompts following the Prompt Tuning Guide in our documentation.

Versioning

Please see the breaking changes document for notes on our approach to versioning the project.

Always run graphrag init --root [path] --force between minor version bumps to ensure you have the latest config format. Run the provided migration notebook between major version bumps if you want to avoid re-indexing prior datasets. Note that this will overwrite your configuration and prompts, so backup if necessary.

Responsible AI FAQ

See RAI_TRANSPARENCY.md

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Privacy

Microsoft Privacy Statement