more doc

README.md

@@ -20,7 +20,8 @@ Clone the repository from: https://github.com/DL4DS/dl4ds_tutor
 Put your data under the `storage/data` directory. Note: You can add urls in the urls.txt file, and other pdf files in the `storage/data` directory.    
 
 To create the Vector Database, run the following command:   
-```python code/modules/vector_db.py```
+```python code/modules/vector_db.py```    
+(Note: You would need to run the above when you add new data to the `storage/data` directory, or if the ``storage/data/urls.txt`` file is updated. Or you can set ``["embedding_options"]["embedd_files"]`` to True in the `code/config.yaml` file, which would embed files from the storage directory everytime you run the below chainlit command.)
 
 To run the chainlit app, run the following command:   
 ```chainlit run code/main.py```

docs/README.md

@@ -37,6 +37,7 @@
 
 ## Useful Configurations
 set these in `code/config.yaml`:
+* ``["embedding_options"]["embedd_files"]`` - If set to True, embeds the files from the storage directory everytime you run the chainlit command. If set to False, uses the stored vector database.
 * ``["embedding_options"]["expand_urls"]`` - If set to True, gets and reads the data from all the links under the url provided. If set to False, only reads the data in the url provided.
 * ``["embedding_options"]["search_top_k"]`` - Number of sources that the retriever returns
 * ``["llm_params]["use_history"]`` - Whether to use history in the prompt or not