diff --git a/README.md b/README.md index 1bf02f6f3..da9695e7c 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,12 @@ Follow these steps to quickly set up and run the ChatGPT Retrieval Plugin: export REDIS_DOC_PREFIX= export REDIS_DISTANCE_METRIC= export REDIS_INDEX_TYPE= + + # Llama + export LLAMA_INDEX_TYPE= + export LLAMA_INDEX_JSON_PATH= + export LLAMA_QUERY_KWARGS_JSON_PATH= + export LLAMA_RESPONSE_MODE= ``` 10. Run the API locally: `poetry run start` @@ -469,3 +475,6 @@ We would like to extend our gratitude to the following contributors for their co - [Redis](https://redis.io/) - [spartee](https://github.com/spartee) - [tylerhutcherson](https://github.com/tylerhutcherson) +- [LlamaIndex](https://github.com/jerryjliu/llama_index) + - [jerryjliu](https://github.com/jerryjliu) + - [Disiok](https://github.com/Disiok) \ No newline at end of file diff --git a/docs/providers/llama/setup.md b/docs/providers/llama/setup.md index 418c2e5fb..2378700dd 100644 --- a/docs/providers/llama/setup.md +++ b/docs/providers/llama/setup.md @@ -16,20 +16,20 @@ with ChatGPT and your external data. **Retrieval App Environment Variables** -| Name | Required | Description | -| ---------------- | -------- | -------------------------------------- | +| Name | Required | Description | +|------------------|----------|-------------------------------------| | `DATASTORE` | Yes | Datastore name. Set this to `llama` | -| `BEARER_TOKEN` | Yes | Your secret token | -| `OPENAI_API_KEY` | Yes | Your OpenAI API key | +| `BEARER_TOKEN` | Yes | Your secret token | +| `OPENAI_API_KEY` | Yes | Your OpenAI API key | **Llama Datastore Environment Variables** -| Name | Required | Description | Default | -| ------------------------------- | -------- | ------------------------------------------------------------------ | ------------------ | -| `LLAMA_INDEX_TYPE` | Optional | Index type (see below for details) | `simple_dict` | -| `LLAMA_INDEX_JSON_PATH` | Optional | Path to saved Index json file | None | -| `LLAMA_QUERY_KWARGS_JSON_PATH` | Optional | Path to saved query kwargs json file | None | -| `LLAMA_RESPONSE_MODE` | Optional | Response mode for query | `no_text` | +| Name | Required | Description | Default | +|--------------------------------|----------|--------------------------------------|---------------| +| `LLAMA_INDEX_TYPE` | Optional | Index type (see below for details) | `simple_dict` | +| `LLAMA_INDEX_JSON_PATH` | Optional | Path to saved Index json file | None | +| `LLAMA_QUERY_KWARGS_JSON_PATH` | Optional | Path to saved query kwargs json file | None | +| `LLAMA_RESPONSE_MODE` | Optional | Response mode for query | `no_text` | **Different Index Types**