mirror of
https://github.com/microsoft/graphrag.git
synced 2025-06-26 23:19:58 +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>
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# Configuring GraphRAG Indexing
|
|
|
|
To start using GraphRAG, you must generate a configuration file. The `init` command is the easiest way to get started. It will create a `.env` and `settings.yaml` files in the specified directory with the necessary configuration settings. It will also output the default LLM prompts used by GraphRAG.
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
graphrag init [--root PATH] [--force, --no-force]
|
|
```
|
|
|
|
## Options
|
|
|
|
- `--root PATH` - The project root directory to initialize graphrag at. Default is the current directory.
|
|
- `--force`, `--no-force` - Optional, default is --no-force. Overwrite existing configuration and prompt files if they exist.
|
|
|
|
## Example
|
|
|
|
```sh
|
|
graphrag init --root ./ragtest
|
|
```
|
|
|
|
## Output
|
|
|
|
The `init` command will create the following files in the specified directory:
|
|
|
|
- `settings.yaml` - The configuration settings file. This file contains the configuration settings for GraphRAG.
|
|
- `.env` - The environment variables file. These are referenced in the `settings.yaml` file.
|
|
- `prompts/` - The LLM prompts folder. This contains the default prompts used by GraphRAG, you can modify them or run the [Auto Prompt Tuning](../prompt_tuning/auto_prompt_tuning.md) command to generate new prompts adapted to your data.
|
|
|
|
## Next Steps
|
|
|
|
After initializing your workspace, you can either run the [Prompt Tuning](../prompt_tuning/auto_prompt_tuning.md) command to adapt the prompts to your data or even start running the [Indexing Pipeline](../index/overview.md) to index your data. For more information on configuring GraphRAG, see the [Configuration](overview.md) documentation.
|