A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
Chris Trevino 9f1a22d682 merge main
2024-10-30 14:50:43 -07:00
.github Allow ci/cd to skip draft PRs (#1314) 2024-10-23 12:46:00 -04:00
.semversioner semver 2024-10-30 13:00:02 -07:00
.vscode update ruff, move ruff settings to ruff.toml 2024-10-30 12:55:37 -07:00
docs Auto-generate CLI doc pages (#1325) 2024-10-25 19:00:24 -04:00
examples Correct links to datashaper verbs in comments (#1068) 2024-09-12 12:44:38 -06:00
examples_notebooks/community_contrib Replace current docs by mkdocs (#1263) 2024-10-11 13:39:03 -06:00
graphrag update ruff, move ruff settings to ruff.toml 2024-10-30 12:55:37 -07:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests update ruff, move ruff settings to ruff.toml 2024-10-30 12:55:37 -07:00
.gitattributes move mkdocs-typer to devdeps (#1331) 2024-10-30 14:49:30 -07:00
.gitignore Fix vector store logic and refactor audience parameter (#1259) 2024-10-21 16:56:56 -04:00
.vsts-ci.yml Initial Release 2024-07-01 15:25:30 -06:00
CHANGELOG.md Release v0.3.6 (#1172) 2024-09-19 18:29:52 -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 ignore ruff.toml in spellcheck 2024-10-30 13:17:45 -07:00
DEVELOPING.md fix typo. Update documentation URLs for consistency (#1298) 2024-10-21 17:24:17 -06:00
dictionary.txt Auto-generate CLI doc pages (#1325) 2024-10-25 19:00:24 -04:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
mkdocs.yaml Auto-generate CLI doc pages (#1325) 2024-10-25 19:00:24 -04:00
poetry.lock merge main 2024-10-30 14:50:43 -07:00
pyproject.toml merge main 2024-10-30 14:50:43 -07: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
ruff.toml update ruff, move ruff settings to ruff.toml 2024-10-30 12:55:37 -07: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 fix typo. Update documentation URLs for consistency (#1298) 2024-10-21 17:24:17 -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.

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