wehub-resource-sync
6b7e6b44f1
Python Build and Type Check / python-ci (ubuntu-latest, 3.11) (push) Has been cancelled
Python Build and Type Check / python-ci (ubuntu-latest, 3.13) (push) Has been cancelled
Python Build and Type Check / python-ci (windows-latest, 3.11) (push) Has been cancelled
Python Build and Type Check / python-ci (windows-latest, 3.13) (push) Has been cancelled
Python Integration Tests / python-ci (ubuntu-latest, 3.13) (push) Has been cancelled
Python Integration Tests / python-ci (windows-latest, 3.13) (push) Has been cancelled
Python Notebook Tests / python-ci (ubuntu-latest, 3.13) (push) Has been cancelled
Python Notebook Tests / python-ci (windows-latest, 3.13) (push) Has been cancelled
Python Smoke Tests / python-ci (ubuntu-latest, 3.13) (push) Has been cancelled
Python Smoke Tests / python-ci (windows-latest, 3.13) (push) Has been cancelled
Python Unit Tests / python-ci (ubuntu-latest, 3.13) (push) Has been cancelled
Python Unit Tests / python-ci (windows-latest, 3.13) (push) Has been cancelled
gh-pages / build (push) Has been cancelled
Python Publish (pypi) / Upload release to PyPI (push) Has been cancelled
Spellcheck / spellcheck (push) Has been cancelled
40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# GraphRAG Indexing 🤖
|
|
|
|
The GraphRAG indexing package is a data pipeline and transformation suite that is designed to extract meaningful, structured data from unstructured text using LLMs.
|
|
|
|
Indexing Pipelines are configurable. They are composed of workflows, standard and custom steps, prompt templates, and input/output adapters. Our standard pipeline is designed to:
|
|
|
|
- extract entities, relationships and claims from raw text
|
|
- perform community detection in entities
|
|
- generate community summaries and reports at multiple levels of granularity
|
|
- embed text into a vector space
|
|
|
|
The outputs of the pipeline are stored as Parquet tables by default, and embeddings are written to your configured vector store.
|
|
|
|
## Getting Started
|
|
|
|
### Requirements
|
|
|
|
See the [requirements](../developing.md#requirements) section in [Get Started](../get_started.md) for details on setting up a development environment.
|
|
|
|
To configure GraphRAG, see the [configuration](../config/overview.md) documentation.
|
|
After you have a config file you can run the pipeline using the CLI or the Python API.
|
|
|
|
## Usage
|
|
|
|
### CLI
|
|
|
|
```bash
|
|
uv run poe index --root <data_root> # default config mode
|
|
```
|
|
|
|
### Python API
|
|
|
|
Please see the indexing API [python file](https://github.com/microsoft/graphrag/blob/main/packages/graphrag/graphrag/api/index.py) for the recommended method to call directly from Python code.
|
|
|
|
## Further Reading
|
|
|
|
- To start developing within the _GraphRAG_ project, see [getting started](../developing.md)
|
|
- To understand the underlying concepts and execution model of the indexing library, see [the architecture documentation](../index/architecture.md)
|
|
- To read more about configuring the indexing engine, see [the configuration documentation](../config/overview.md)
|