A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
Yuan Chai 2b7d28944d
Fix encoding issue: Ensure non-ASCII characters are correctly represe… (#1446)
Fix encoding issue: Ensure non-ASCII characters are correctly represented in entity name key

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
2024-11-26 17:47:06 -06:00
.github Update CI/CD - skip running unit tests on documentation-only PRs (#1371) 2024-11-06 14:19:21 -05:00
.semversioner Fix dynamic community selection in global search (#1450) 2024-11-26 15:19:50 -06:00
.vscode Feat/update cli (#1376) 2024-11-07 06:59:10 -06:00
docs Improve CLI speed with lazy imports (#1319) 2024-11-15 19:41:10 -05:00
examples Improve CLI speed with lazy imports (#1319) 2024-11-15 19:41:10 -05:00
examples_notebooks/community_contrib Artifact cleanup (#1341) 2024-11-13 15:11:19 -08:00
graphrag Fix encoding issue: Ensure non-ASCII characters are correctly represe… (#1446) 2024-11-26 17:47:06 -06:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests Improve CLI speed with lazy imports (#1319) 2024-11-15 19:41:10 -05:00
.gitattributes move mkdocs-typer to devdeps (#1331) 2024-10-30 14:49:30 -07:00
.gitignore Implement dynamic community selection for global search (#1396) 2024-11-11 16:45:07 -08:00
.vsts-ci.yml Initial Release 2024-07-01 15:25:30 -06:00
CHANGELOG.md Release v0.5.0 (#1415) 2024-11-18 00:06:54 -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 Replace current docs by mkdocs (#1263) 2024-10-11 13:39:03 -06:00
DEVELOPING.md fix typo. Update documentation URLs for consistency (#1298) 2024-10-21 17:24:17 -06:00
dictionary.txt Add visualization guide (#1340) 2024-11-06 14:06:50 -05:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
mkdocs.yaml First cut at config cleanup (#1411) 2024-11-15 14:33:26 -08:00
poetry.lock Updated the variable names within the for-loop to differentiate betwe… (#1356) 2024-11-05 11:45:29 -06:00
pyproject.toml Release v0.5.0 (#1415) 2024-11-18 00:06:54 -06:00
RAI_TRANSPARENCY.md Initial Release 2024-07-01 15:25:30 -06:00
README.md fix typo. Update documentation URLs for consistency (#1298) 2024-10-21 17:24:17 -06: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
v1-breaking-changes.md First cut at config cleanup (#1411) 2024-11-15 14:33:26 -08: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.

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