Merge pull request #3 from TuanaCelik/requesting-openai-key

app.py

@@ -3,11 +3,13 @@ from annotated_text import annotation
 from json import JSONDecodeError
 import logging
 from markdown import markdown
+import requests
 
 import streamlit as st
 
-from utils.haystack import query
+from utils.haystack import query, start_haystack
 from utils.ui import reset_results, set_initial_state, sidebar
+from utils.config import TWITTER_BEARER
 
 set_initial_state()
 
@@ -15,38 +17,42 @@ sidebar()
 
 st.write("# 🐤 What have they been tweeting about lately?")
 
-search_bar, button = st.columns(2)
-# Search bar
-with search_bar: 
-    username = st.text_input("Please provide a twitter username", on_change=reset_results)
-
-with button: 
-    st.write("")
-    st.write("")
-    run_pressed = st.button("Search tweets")
-
-run_query = (
-    run_pressed or username != st.session_state.username
-)
-
-# Get results for query
-if run_query and username:
-    reset_results()
-    st.session_state.username = username
-    with st.spinner("🔎"):
-        try:
-            st.session_state.result = query(username)
-        except JSONDecodeError as je:
-            st.error(
-                "👓    An error occurred reading the results. Is the document store working?"
-            )    
-        except Exception as e:
-            logging.exception(e)
-            st.error("🐞    An error occurred during the request.")
-        
-            
-
-if st.session_state.result:
-    voice = st.session_state.result
-    st.write(voice[0])
-        
+if st.session_state.get("OPENAI_API_KEY"):
+    prompter, template = start_haystack(st.session_state.get("OPENAI_API_KEY"))
+    st.session_state["api_key_configured"] = True
+    search_bar, button = st.columns(2)
+    # Search bar
+    with search_bar: 
+        username = st.text_input("Please provide a twitter username", on_change=reset_results)
+
+    with button: 
+        st.write("")
+        st.write("")
+        run_pressed = st.button("Search tweets")
+else:
+    st.write("Please provide your OpenAI Key to start using the application")
+    
+if st.session_state.get("api_key_configured"):
+    run_query = (
+        run_pressed or username != st.session_state.username
+    )
+
+    # Get results for query
+    if run_query and username:
+        reset_results()
+        st.session_state.username = username
+        with st.spinner("🔎"):
+            try:
+                st.session_state.result = query(username, prompter, template)
+            except JSONDecodeError as je:
+                st.error(
+                    "👓    An error occurred reading the results. Is the document store working?"
+                )    
+            except Exception as e:
+                logging.exception(e)
+                st.error("🐞    An error occurred during the request.")            
+                
+    if st.session_state.result:
+        voice = st.session_state.result
+        st.write(voice[0])
+            

utils/config.py

@@ -2,5 +2,4 @@ import os
 from dotenv import load_dotenv
 
 load_dotenv()
-TWITTER_BEARER = os.getenv('TWITTER_BEARER_TOKEN')
-OPEN_AI_KEY = os.getenv('OPEN_AI_KEY')
+TWITTER_BEARER = os.getenv('TWITTER_BEARER_TOKEN')

utils/haystack.py

@@ -1,16 +1,15 @@
 import streamlit as st
 import requests
-from utils.config import TWITTER_BEARER, OPEN_AI_KEY
+from utils.config import TWITTER_BEARER
 
 from haystack.nodes import PromptNode, PromptTemplate
 
 # cached to make index and models load only at start
-@st.cache(
-    hash_funcs={"builtins.SwigPyObject": lambda _: None}, allow_output_mutation=True
-)
-def start_haystack():
+@st.cache(hash_funcs={"builtins.CoreBPE": lambda _: None}, show_spinner=False, allow_output_mutation=True)
+def start_haystack(openai_key):
     #Use this function to contruct a pipeline
-    prompt_node = PromptNode(model_name_or_path="text-davinci-003", api_key=OPEN_AI_KEY)
+    prompt_node = PromptNode(model_name_or_path="text-davinci-003", api_key=openai_key)
+
 
     twitter_template = PromptTemplate(name="twitter-voice", prompt_text="""You will be given a twitter stream belonging to a specific profile. Answer with a summary of what they've lately been tweeting about and in what languages.
                                                                     You may go into some detail about what topics they tend to like tweeting about. Please also mention their overall tone, for example: positive,
@@ -37,12 +36,13 @@ def start_haystack():
                                                                     
                                                                     Summary: 
                                                                     """)
+
+    st.session_state["haystack_started"] = True                                                     
     return prompt_node, twitter_template
 
-prompter, template = start_haystack()
 
-@st.cache(show_spinner=False, allow_output_mutation=True)
-def query(username):
+@st.cache(hash_funcs={"builtins.CoreBPE": lambda _: None}, show_spinner=False, allow_output_mutation=True)
+def query(username, prompter, template):
 
     bearer_token = TWITTER_BEARER
 

utils/ui.py

@@ -8,10 +8,14 @@ def set_state_if_absent(key, value):
 def set_initial_state():
     set_state_if_absent("username", "Provide a Twitter username")
     set_state_if_absent("result", None)
+    set_state_if_absent("haystack_started", False)
 
 def reset_results(*args):
     st.session_state.result = None
 
+def set_openai_api_key(api_key: str):
+    st.session_state["OPENAI_API_KEY"] = api_key
+
 def sidebar():
     with st.sidebar:
         image = Image.open('logo/haystack-logo-colored.png')
@@ -21,6 +25,25 @@ def sidebar():
         "**Take results with a grain of** 🧂\n\n"
         "For more on how this was built, instructions to run locally and to contribute: [visit GitHub](https://github.com/TuanaCelik/should-i-follow#readme)")
 
+        st.markdown(
+            "## How to use\n"
+            "1. Enter your [OpenAI API key](https://platform.openai.com/account/api-keys) below\n"
+            "2. Enter a Twitter username in the searchbar\n"
+            "3. Enjoy 🤗\n"
+        )
+
+        api_key_input = st.text_input(
+            "OpenAI API Key",
+            type="password",
+            placeholder="Paste your OpenAI API key here (sk-...)",
+            help="You can get your API key from https://platform.openai.com/account/api-keys.",
+            value=st.session_state.get("OPENAI_API_KEY", ""),
+        )
+
+        if api_key_input:
+            set_openai_api_key(api_key_input)
+
+        st.markdown("---")
         st.markdown(
             "## How this works\n"
             "This app was built with [Haystack](https://haystack.deepset.ai) using the"
@@ -30,4 +53,7 @@ def sidebar():
             "You can see how the `PromptNode` was set up [here](https://github.com/TuanaCelik/should-i-follow/blob/main/utils/haystack.py)")
         st.markdown("---")
         st.markdown("Made by [tuanacelik](https://twitter.com/tuanacelik)")
-        st.image(image, width=250)
+        st.markdown("---")
+        st.markdown("""Thanks to [mmz_001](https://twitter.com/mm_sasmitha) 
+                        for open sourcing [KnowledgeGPT](https://knowledgegpt.streamlit.app/) which helped me with this sidebar 🙏🏽""")
+        st.image(image, width=250)