From fcd3504757be1c5d2823fc33affd0c50e054faa0 Mon Sep 17 00:00:00 2001
From: Iman Reihanian <ireihani@uci.edu>
Date: Thu, 18 Jul 2024 16:18:28 -0700
Subject: [PATCH] Added more examples to the .env.example file.

---
 .env.example | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --git a/.env.example b/.env.example
index da7aa521c..11e760346 100644
--- a/.env.example
+++ b/.env.example
@@ -1,9 +1,38 @@
+# .env.example
+
+# OpenAI API key for accessing OpenAI's GPT models
 OPENAI_API_KEY=
+
+# API key for accessing Tavily's services
 TAVILY_API_KEY=
+
+# API key for accessing LangChain's services
 LANGCHAIN_API_KEY=
+
+# Path to the directory where documents are stored
 DOC_PATH=./my-docs
 
-# the name of the embedding model to use for Ollama
+# The name of the embedding model to use for Ollama
 OLLAMA_EMBEDDING_MODEL=
-# the Ollama endpoint to use
-OLLAMA_BASE_URL=
\ No newline at end of file
+
+# The Ollama endpoint to use
+OLLAMA_BASE_URL=
+
+# Choose one of the available retrievers by uncommenting the desired retriever:
+# RETRIEVER=arxiv
+# RETRIEVER=bing
+# RETRIEVER=custom
+# RETRIEVER=duckduckgo
+# RETRIEVER=exa
+# RETRIEVER=google
+# RETRIEVER=searx
+# RETRIEVER=semantic_scholar
+# RETRIEVER=serpapi
+# RETRIEVER=serper
+# RETRIEVER=tavily
+
+# Example setting for retriever
+RETRIEVER=tavily
+
+# Maximum number of search results to return per query
+MAX_SEARCH_RESULTS_PER_QUERY=5