Update app.py

app.py

@@ -27,9 +27,12 @@ _ = load_dotenv(find_dotenv())
   #api_key=os.getenv("OPENAI_API_KEY"),  
 #)
 
-#nur bei ersten Anfrage splitten der Dokumente
+#################################################
+#globale Variablen
+#nur bei ersten Anfrage splitten der Dokumente - um die Vektordatenbank entsprechend zu füllen
 splittet = False
 
+##################################################
 #Für MongoDB statt Chroma als Vektorstore
 #MONGODB_URI = os.environ["MONGODB_ATLAS_CLUSTER_URI"]
 #client = MongoClient(MONGODB_URI)
@@ -38,31 +41,44 @@ splittet = False
 #MONGODB_COLLECTION = client[MONGODB_DB_NAME][MONGODB_COLLECTION_NAME]
 #MONGODB_INDEX_NAME = "default"
 
+#################################################
+#Prompt Zusätze
 template = """Antworte in deutsch, wenn es nicht explizit anders gefordert wird. Wenn du die Antwort nicht kennst, antworte einfach, dass du es nicht weißt. Versuche nicht, die Antwort zu erfinden oder aufzumocken. Halte die Antwort so kurz aber exakt."""
 
 llm_template = "Beantworte die Frage am Ende. " + template + "Frage: {question} Hilfreiche Antwort: "
 rag_template = "Nutze die folgenden Kontext Teile, um die Frage zu beantworten am Ende. " + template + "{context} Frage: {question} Hilfreiche Antwort: "
 
+#################################################
+#Konstanten
 LLM_CHAIN_PROMPT = PromptTemplate(input_variables = ["question"], 
                                   template = llm_template)
 RAG_CHAIN_PROMPT = PromptTemplate(input_variables = ["context", "question"], 
                                   template = rag_template)
 
 OAI_API_KEY=os.getenv("OPENAI_API_KEY")
-#Pfad, wo Docs abgelegt werden können - lokal, also hier im HF Space (sonst auf eigenem Rechner)
+#Pfad, wo Docs/Bilder/Filme abgelegt werden können - lokal, also hier im HF Space (sonst auf eigenem Rechner)
 PATH_WORK = "."
 CHROMA_DIR  = "/chroma"
 YOUTUBE_DIR = "/youtube"
 
+###############################################
+#URLs zu Dokumenten oder andere Inhalte, die einbezogen werden sollen
 PDF_URL       = "https://arxiv.org/pdf/2303.08774.pdf"
 WEB_URL       = "https://openai.com/research/gpt-4"
 YOUTUBE_URL_1 = "https://www.youtube.com/watch?v=--khbXchTeE"
 YOUTUBE_URL_2 = "https://www.youtube.com/watch?v=hdhZwyf24mE"
 YOUTUBE_URL_3 = "https://www.youtube.com/watch?v=vw-KWfKwvTQ"
 
+
+################################################
+#LLM Model mit dem gearbeitet wird
 #MODEL_NAME  = "gpt-3.5-turbo-16k"
 MODEL_NAME  ="gpt-4"
 
+#################################################
+#Funktionen zur Verarbeitung
+################################################
+#die Inhalte splitten, um in Vektordatenbank entsprechend zu laden als Splits
 def document_loading_splitting():
     global splittet
     # Document loading
@@ -87,17 +103,20 @@ def document_loading_splitting():
     splittet = True
     return splits
 
+#Chroma DB die splits ablegen - vektorisiert...
 def document_storage_chroma(splits):
     Chroma.from_documents(documents = splits, 
                           embedding = OpenAIEmbeddings(disallowed_special = ()), 
                           persist_directory = PATH_WORK + CHROMA_DIR)
 
+#Mongo DB die splits ablegen - vektorisiert...
 def document_storage_mongodb(splits):
     MongoDBAtlasVectorSearch.from_documents(documents = splits,
                                             embedding = OpenAIEmbeddings(disallowed_special = ()),
                                             collection = MONGODB_COLLECTION,
                                             index_name = MONGODB_INDEX_NAME)
 
+#dokumente in chroma db vektorisiert ablegen können - die Db vorbereiten daüfur
 def document_retrieval_chroma(llm, prompt):      
     embeddings = OpenAIEmbeddings()
     #Alternative Embedding - für Vektorstore, um Ähnlichkeitsvektoren zu erzeugen
@@ -107,6 +126,7 @@ def document_retrieval_chroma(llm, prompt):
     
     return db
 
+#dokumente in mongo db vektorisiert ablegen können - die Db vorbereiten daüfür
 def document_retrieval_mongodb(llm, prompt):
     db = MongoDBAtlasVectorSearch.from_connection_string(MONGODB_URI,
                                                          MONGODB_DB_NAME + "." + MONGODB_COLLECTION_NAME,
@@ -114,11 +134,16 @@ def document_retrieval_mongodb(llm, prompt):
                                                          index_name = MONGODB_INDEX_NAME)
     return db
 
+###############################################
+#Langchain anlegen
+
+#langchain nutzen, um prompt an LLM zu leiten - llm und prompt sind austauschbar
 def llm_chain(llm, prompt):
     llm_chain = LLMChain(llm = llm, prompt = LLM_CHAIN_PROMPT)
     result = llm_chain.run({"question": prompt})
     return result
 
+#langchain nutzen, um prompt an llm zu leiten, aber vorher in der VektorDB suchen, um passende splits zum Prompt hinzuzufügen
 def rag_chain(llm, prompt, db):
     rag_chain = RetrievalQA.from_chain_type(llm, 
                                             chain_type_kwargs = {"prompt": RAG_CHAIN_PROMPT}, 
@@ -127,20 +152,25 @@ def rag_chain(llm, prompt, db):
     result = rag_chain({"query": prompt})
     return result["result"]
 
+###################################################
+#Funktion von Gradio aus, die den dort eingegebenen Prompt annimmt und weiterverarbeitet
 def invoke(openai_api_key, rag_option, prompt):
     global splittet
     
     if (openai_api_key == "" or openai_api_key == "sk-"):
         #raise gr.Error("OpenAI API Key is required.")
+        #eigenen OpenAI key nutzen
         openai_api_key= OAI_API_KEY
     if (rag_option is None):
         raise gr.Error("Retrieval Augmented Generation ist erforderlich.")
     if (prompt == ""):
         raise gr.Error("Prompt ist erforderlich.")
     try:
+        #Anfrage an OpenAI
         llm = ChatOpenAI(model_name = MODEL_NAME, 
                          openai_api_key = openai_api_key, 
                          temperature = 0)
+        #zusätzliche Dokumenten Splits aus DB zum Prompt hinzufügen (aus VektorDB - Chroma oder Mongo DB)
         if (rag_option == "Chroma"):
             #muss nur einmal ausgeführt werden... 
             if not splittet: