A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
JunHo Kim (김준호) d66901e67e
Update description of GRAPHRAG_CACHE_BASE_DIR in env_vars.md (#1213)
* Update description of GRAPHRAG_CACHE_BASE_DIR in env_vars.md

Clarified that `GRAPHRAG_CACHE_BASE_DIR` refers to the base directory path for cache files rather than reporting outputs. This improves the accuracy of the documentation and helps users understand the correct usage of this environment variable.

* Update description of `GRAPHRAG_CACHE_BASE_DIR`

Simplified the description of `GRAPHRAG_CACHE_BASE_DIR` to make it clearer. Changed "base directory path" to "base path" for conciseness.

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
2024-10-09 15:16:50 -06:00
.github Remove unused cols from final entities (#1226) 2024-09-27 17:10:52 -06:00
.semversioner Migrate helper verbs (#1248) 2024-10-09 13:46:44 -07:00
.vscode Initial Release 2024-07-01 15:25:30 -06:00
docsite Update description of GRAPHRAG_CACHE_BASE_DIR in env_vars.md (#1213) 2024-10-09 15:16:50 -06:00
examples Correct links to datashaper verbs in comments (#1068) 2024-09-12 12:44:38 -06:00
examples_notebooks Add graphrag_import_neo4j_cypher Notebook (#593) 2024-08-23 15:18:35 -06:00
graphrag Migrate helper verbs (#1248) 2024-10-09 13:46:44 -07:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests Migrate helper verbs (#1248) 2024-10-09 13:46:44 -07:00
.gitignore Change lancedb placement (#996) 2024-08-22 11:39:55 -06: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 Initial Release 2024-07-01 15:25:30 -06:00
DEVELOPING.md Update developer guide (#1029) 2024-08-26 12:28:03 -04:00
dictionary.txt Migrate helper verbs (#1248) 2024-10-09 13:46:44 -07:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
poetry.lock Release v0.3.6 (#1172) 2024-09-19 18:29:52 -06:00
pyproject.toml Release v0.3.6 (#1172) 2024-09-19 18:29:52 -06:00
RAI_TRANSPARENCY.md Initial Release 2024-07-01 15:25:30 -06:00
README.md Docs updates aug06 (#852) 2024-08-06 16:31:47 -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 Migrate towards using static output directories (#1113) 2024-09-18 17:36:50 -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