From 9ca9552fbc2cfb482848c857f226527ef723e8b6 Mon Sep 17 00:00:00 2001
From: isafulf <51974293+isafulf@users.noreply.github.com>
Date: Wed, 10 May 2023 13:30:24 -0700
Subject: [PATCH] Update README.md

---
 README.md | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 53fc7a815..47e7ae3db 100644
--- a/README.md
+++ b/README.md
@@ -35,13 +35,14 @@ This README provides detailed information on how to set up, develop, and deploy
   - [Setup](#setup)
     - [General Environment Variables](#general-environment-variables)
   - [Choosing a Vector Database](#choosing-a-vector-database)
-    - [Chroma](#chroma)
     - [Pinecone](#pinecone)
     - [Weaviate](#weaviate)
     - [Zilliz](#zilliz)
     - [Milvus](#milvus)
     - [Qdrant](#qdrant)
     - [Redis](#redis)
+    - [Llama Index](#llamaindex)
+    - [Chroma](#chroma)
   - [Running the API Locally](#running-the-api-locally)
   - [Testing a Localhost Plugin in ChatGPT](#testing-a-localhost-plugin-in-chatgpt)
   - [Personalization](#personalization)
@@ -121,12 +122,19 @@ Follow these steps to quickly set up and run the ChatGPT Retrieval Plugin:
    export REDIS_DOC_PREFIX=<your_redis_doc_prefix>
    export REDIS_DISTANCE_METRIC=<your_redis_distance_metric>
    export REDIS_INDEX_TYPE=<your_redis_index_type>
-   
+
    # Llama
    export LLAMA_INDEX_TYPE=<gpt_vector_index_type>
    export LLAMA_INDEX_JSON_PATH=<path_to_saved_index_json_file>
    export LLAMA_QUERY_KWARGS_JSON_PATH=<path_to_saved_query_kwargs_json_file>
-   export LLAMA_RESPONSE_MODE=<response_mode_for_query> 
+   export LLAMA_RESPONSE_MODE=<response_mode_for_query>
+
+   # Chroma
+   export CHROMA_COLLECTION=<your_chroma_collection>
+   export CHROMA_IN_MEMORY=<true_or_false>
+   export CHROMA_PERSISTENCE_DIR=<your_chroma_persistence_directory>
+   export CHROMA_HOST=<your_chroma_host>
+   export CHROMA_PORT=<your_chroma_port>
    ```
 
 10. Run the API locally: `poetry run start`
@@ -259,10 +267,6 @@ The plugin supports several vector database providers, each with different featu
 
 For more detailed instructions on setting up and using each vector database provider, please refer to the respective documentation in the `/docs/providers/<datastore_name>/setup.md` file ([folders here](/docs/providers)).
 
-#### Chroma
-
-[Chroma](https://trychroma.com) is an AI-native open-source embedding database designed to make getting started as easy as possible. Chroma runs in-memory, or in a client-server setup. It supports metadata and keyword filtering out of the box. For detailed instructions, refer to [`/docs/providers/chroma/setup.md`](/docs/providers/chroma/setup.md).
-
 #### Pinecone
 
 [Pinecone](https://www.pinecone.io) is a managed vector database designed for speed, scale, and rapid deployment to production. It supports hybrid search and is currently the only datastore to natively support SPLADE sparse vectors. For detailed setup instructions, refer to [`/docs/providers/pinecone/setup.md`](/docs/providers/pinecone/setup.md).
@@ -297,6 +301,10 @@ All you need to do is specifying a few environment variables (optionally point t
 Note that metadata filters in queries are not yet supported.
 For detailed setup instructions, refer to [`/docs/providers/llama/setup.md`](/docs/providers/llama/setup.md).
 
+#### Chroma
+
+[Chroma](https://trychroma.com) is an AI-native open-source embedding database designed to make getting started as easy as possible. Chroma runs in-memory, or in a client-server setup. It supports metadata and keyword filtering out of the box. For detailed instructions, refer to [`/docs/providers/chroma/setup.md`](/docs/providers/chroma/setup.md).
+
 ### Running the API locally
 
 To run the API locally, you first need to set the requisite environment variables with the `export` command:
@@ -486,4 +494,4 @@ We would like to extend our gratitude to the following contributors for their co
   - [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
+  - [Disiok](https://github.com/Disiok)