mirror of
https://github.com/microsoft/graphrag.git
synced 2025-07-05 08:01:23 +00:00
bcb74789f1
* Wordind updates * Update yam lconfig and add notes to "deprecated" env * Add basic search section * Update versioning docs * Minor edits for clarity * Update init command * Update init to add --force in docs * Add NLP extraction params * Move vector_store to root * Add workflows to config * Add FastGraphRAG docs * add metadata column changes * Added documentation for multi index search. * Minor fixes. * Add config and table renames * Update migration notebook and comments to specify v1 * Add frequency to entity table docs * add new chunking options for metadata * Update output docs * Minor edits and cleanup * Add model ids to search configs * Spruce up migration notebook * Lint/format multi-index notebook * SpaCy model note * Update SpaCy footnote * Updated multi_index_search.ipynb to remove ruff errors. * add spacy to dictionary --------- Co-authored-by: Alonso Guevara <alonsog@microsoft.com> Co-authored-by: Dayenne Souza <ddesouza@microsoft.com> Co-authored-by: dorbaker <dorbaker@microsoft.com>
42 lines
1.8 KiB
Markdown
42 lines
1.8 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 entities into a graph vector space
|
|
- embed text chunks into a textual 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
|
|
# Via Poetry
|
|
poetry 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/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)
|