diff --git a/README.md b/README.md index d86a021..e15bcea 100644 --- a/README.md +++ b/README.md @@ -175,6 +175,13 @@ Default username / password are: `admin` / `admin`. You can setup additional use - Check the Resources tab and LLMs and Embeddings and ensure that your `api_key` value is set correctly from your `.env`. file. If it is not set, you can set it here. +## Setup GraphRAG + +NOTE: Currently GraphRAG feature only works with OpenAI or Ollama API. + +- To use GraphRAG retriever feature, make sure to set `GRAPHRAG_API_KEY` environment variables (or in the `.env` file). +- To use GraphRAG with local models (Ollama), set `USE_CUSTOMIZED_GRAPHRAG_SETTING=true` and tweak your settings in `kotaemon/settings.yaml.example`. + ## Setup local models (for local / private RAG) See [Local model setup](docs/local_model.md).