From ad386ea8bf540983cbb10ade092f3f536e5427f2 Mon Sep 17 00:00:00 2001
From: zach-blumenfeld <zach.blumenfeld@neo4j.com>
Date: Fri, 20 Oct 2023 16:17:28 -0400
Subject: [PATCH] ReOrg env.template File for Clarity

---
 env.example | 50 +++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 39 insertions(+), 11 deletions(-)

diff --git a/env.example b/env.example
index 4d072043..2a9457ac 100644
--- a/env.example
+++ b/env.example
@@ -1,15 +1,43 @@
-#OPENAI_API_KEY=sk-...
-#AWS_ACCESS_KEY_ID=
-#AWS_SECRET_ACCESS_KEY=
-#AWS_DEFAULT_REGION=us-east-1
-#OLLAMA_BASE_URL=http://host.docker.internal:11434
+#*****************************************************************
+# LLM and Embedding Model
+#*****************************************************************
+LLM=llama2 #or any Ollama model tag, gpt-4, gpt-3.5, or claudev2
+EMBEDDING_MODEL=sentence_transformer #or openai, ollama, or aws
+
+#*****************************************************************
+# Neo4j
+#*****************************************************************
 #NEO4J_URI=neo4j://database:7687
 #NEO4J_USERNAME=neo4j
 #NEO4J_PASSWORD=password
-LLM=llama2 #or any Ollama model tag, gpt-4, gpt-3.5, or claudev2
-EMBEDDING_MODEL=sentence_transformer #or openai, ollama, or aws
 
-LANGCHAIN_ENDPOINT="https://api.smith.langchain.com"
-LANGCHAIN_TRACING_V2=true # false
-LANGCHAIN_PROJECT=#your-project-name
-LANGCHAIN_API_KEY=#your-api-key ls_...
+#*****************************************************************
+# Langchain
+#*****************************************************************
+# Optional for enabling Langchain Smith API
+
+#LANGCHAIN_TRACING_V2=true # false
+#LANGCHAIN_ENDPOINT="https://api.smith.langchain.com"
+#LANGCHAIN_PROJECT=#your-project-name
+#LANGCHAIN_API_KEY=#your-api-key ls_...
+
+#*****************************************************************
+# Ollama
+#*****************************************************************
+#OLLAMA_BASE_URL=http://host.docker.internal:11434
+
+#*****************************************************************
+# OpenAI
+#*****************************************************************
+# Only required when using OpenAI LLM or embedding model
+
+#OPENAI_API_KEY=sk-...
+
+#*****************************************************************
+# AWS
+#*****************************************************************
+# Only required when using AWS Bedrock LLM or embedding model
+
+#AWS_ACCESS_KEY_ID=
+#AWS_SECRET_ACCESS_KEY=
+#AWS_DEFAULT_REGION=us-east-1
\ No newline at end of file