Update app.py

app.py

@@ -2,7 +2,7 @@ import streamlit as st
 from utils import *
 
 
-# streamlit session_state holds history, this mehtods cleas that history
+# streamlit session state holds history, this mehtods cleas that history
 def clear_history():
     if 'history' in st.session_state:
         del st.session_state['history']
@@ -12,32 +12,26 @@ def clear_history():
 if __name__ == "__main__":
     import os
 
-    # loading the OpenAI api key from .env
-    #from dotenv import load_dotenv, find_dotenv
-
-    #load_dotenv(find_dotenv(), override=True)
-
-    # st.image('img.png')
-
+    # create your side bar
     st.subheader('Load a Document and Ask a Question')
     with st.sidebar:
-        # text_input for the OpenAI API key (alternative to python-dotenv and .env)
+        # use text_input to bring in your OpenAI API key 
         api_key = st.text_input('OpenAI API Key:', type='password')
         if api_key:
             os.environ['OPENAI_API_KEY'] = api_key
 
-        # file uploader widget
+        # sidebar - file uploader widget, drag and drop, browse button works on windows not on mac
         uploaded_file = st.file_uploader('To upload a file drag and drop it on the area below:', type=['pdf', 'docx', 'txt', 'csv'])
 
-        # chunk size number widget
+        # call the chunk size mehtod that sets the number
         chunk_size = st.number_input('Chunk size:', min_value=100, max_value=2048, value=512, on_change=clear_history)
 
-        # k number input widget
+        # input the k number, a hight nuber will increase the search effectiveness, but is more expensive
         k = st.number_input('k', min_value=1, max_value=20, value=3, on_change=clear_history)
 
-        # add data button widget
+        # click this sidebard button to add data
         add_data = st.button('Add Data', on_click=clear_history)
-
+        #chekc if data button has been clicked,if the api key is added and if a data file is available for upload
         if add_data:
             if api_key:
                 if uploaded_file and add_data:  # if the user browsed a file
@@ -66,10 +60,10 @@ if __name__ == "__main__":
             else:
                 st.error("Please provide your OpenAI API key above.....")
 
-    # user's question text input widget
+    # this is the main input widget that allows you to input your query of the uploaded document
     q = st.text_input('Ask a question about the content of your file:')
-    if q:  # if the user entered a question and hit enter
-        if 'vs' in st.session_state:  # if there's the vector store (user uploaded, split and embedded a file)
+    if q:  # run the query if the user entered a question and hit enter
+        if 'vs' in st.session_state:  # for seesion state, if there's the vector store (user uploaded, split and embedded a file)
             vector_store = st.session_state.vs
             st.write(f'k: {k}')
             answer = ask_and_get_answer(vector_store, q, k)
@@ -79,17 +73,16 @@ if __name__ == "__main__":
 
             st.divider()
 
-            # if there's no chat history in the session state, create it
+            # initialize a chat history if there's no chat history
             if 'history' not in st.session_state:
                 st.session_state.history = ''
 
-            # the current question and answer
+            # your question and answer
             value = f'Q: {q} \nA: {answer}'
 
             st.session_state.history = f'{value} \n {"-" * 100} \n {st.session_state.history}'
             h = st.session_state.history
 
-            # text area widget for the chat history
+            # chat history text area widget
             st.text_area(label='Chat History', value=h, key='history', height=400)
 
-# run the app: streamlit run ./chat_with_documents.py