A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
KennyZhang1 27c5468a8b
Load query from blob (#1095)
* Moved query loading from file to helper function

* added loading parquets from blob to function

* resolved adlfs async error

* debugging cleanup and small fixes

* added connection string support

* semversioner and ruff fixes

* completed testing for merge with main

* more ruff changes

* fixed unbound vars warning

* rewrote function to use storage utils

* removed unused vars

---------

Co-authored-by: Kenny Zhang <zhangken@microsoft.com>
2024-09-05 18:17:22 -04:00
.github Clean and organize run index code (#1090) 2024-09-05 08:15:10 -06:00
.semversioner Load query from blob (#1095) 2024-09-05 18:17:22 -04:00
.vscode Initial Release 2024-07-01 15:25:30 -06:00
docsite Fix img width (#1061) 2024-08-29 17:02:47 -06:00
examples Modify the URL comment to make it correct. (#482) 2024-07-11 16:19:54 -06:00
examples_notebooks Add graphrag_import_neo4j_cypher Notebook (#593) 2024-08-23 15:18:35 -06:00
graphrag Load query from blob (#1095) 2024-09-05 18:17:22 -04:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests fix setting base_dir to full paths when not using file system. (#1096) 2024-09-04 11:33: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.2 (#1034) 2024-08-26 17:57:16 -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 Fix default entity extraction prompt (#781) 2024-07-30 15:41:10 -06:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
poetry.lock Bump jupyterlab from 4.2.4 to 4.2.5 (#1056) 2024-08-29 12:53:41 -06:00
pyproject.toml Consistent config load_config (#1065) 2024-09-03 16:33:16 -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

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