Added Dialog to add API Keys

src/openfactcheck/app/app.py

@@ -1,3 +1,4 @@
+import os
 import argparse
 import streamlit as st
 from streamlit_option_menu import option_menu
@@ -5,10 +6,10 @@ from streamlit_option_menu import option_menu
 from openfactcheck import OpenFactCheck
 from openfactcheck.lib import OpenFactCheckConfig
 from openfactcheck.app.sidebar import sidebar
+from openfactcheck.app.dialogs import get_secrets
 from openfactcheck.app.evaluate_response import evaluate_response
 from openfactcheck.app.evaluate_llm import evaluate_llm
 from openfactcheck.app.evaluate_factchecker import evaluate_factchecker
-from openfactcheck.app.utils import footer
 
 def parse_args():
     parser = argparse.ArgumentParser(description='Initialize OpenFactCheck with custom configuration.')
@@ -25,26 +26,35 @@ def parse_args():
     
 class App:
     def __init__(self, config_path: str = "config.json"):
+        # Set up Dashboard
+        st.set_page_config(page_title="OpenFactCheck Dashboard", 
+                        page_icon=":bar_chart:", 
+                        layout="wide",
+                        initial_sidebar_state="collapsed")
+        
+        # Get API Keys
+        st.session_state.api_keys = False
+        # Check if the API keys are already set in the environment variables
+        if os.getenv("OPENAI_API_KEY") and os.getenv("SERPER_API_KEY") and os.getenv("SCRAPER_API_KEY"):
+            st.session_state.api_keys = True
+        else:
+            get_secrets()
+        
+        # Initialize OpenFactCheck
         @st.cache_resource(show_spinner=False)
         def init(config_path: str = "config.json"):
-            # Initialize OpenFactCheck
+            # Initialize OpenFactCheckConfig
             config = OpenFactCheckConfig(config_path)
             ofc = OpenFactCheck(config)
+
             return ofc
         
-        self.ofc = init(config_path)
-        pass
+        if st.session_state.api_keys:
+            self.ofc = init(config_path)
+        else:
+            self.ofc = None
 
     def run(self):
-        # Set up Dashboard
-        st.set_page_config(page_title="OpenFactCheck Dashboard", 
-                        page_icon=":bar_chart:", 
-                        layout="wide",
-                        initial_sidebar_state="collapsed")
-        
-        # # Set up footer
-        # footer("Copyright © 2024 MBZUAI | Made with ❤︎ by OpenFactCheck Team")
-
         # Set up Sidebar
         sidebar()
                         
@@ -60,7 +70,10 @@ class App:
             orientation="horizontal"
         )
 
-        st.info("Please provide OpenAI API Key, Serper API Key and Azure Search Key in the sidebar to evaluate LLM response.")
+        # Check if API keys are set
+        if not st.session_state.api_keys:
+            st.warning("Please provide the necessary API keys to proceed.")
+            return
 
         # Load the selected page
         if selected == "Evaluate LLM Response":

src/openfactcheck/app/dialogs.py

@@ -0,0 +1,26 @@
+import os
+import streamlit as st
+
+@st.dialog("Secrets Configuration")
+def get_secrets():
+    st.markdown("Please provide the following keys to evaluate LLM response:")
+    st.info("Keys defined in your environment variables are automatically loaded.")
+
+    # OpenAI API Key
+    st.markdown("You can find the OpenAI API Key [here](https://platform.openai.com/account/api-keys).")
+    openai_api_key = st.text_input("OpenAI API Key", type="password", value=os.getenv("OPENAI_API_KEY", default=""))
+    os.environ["OPENAI_API_KEY"] = openai_api_key
+
+    # Serper API Key
+    st.markdown("You can find the Serper API Key [here](https://serpapi.com/dashboard).")
+    serper_api_key = st.text_input("Serper API Key", type="password", value=os.getenv("SERPER_API_KEY", default=""))
+    os.environ["SERPER_API_KEY"] = serper_api_key
+
+    # ScraperAPI Key
+    st.markdown("You can find the ScraperAPI Key [here](https://www.scraperapi.com/).")
+    scraper_api_key = st.text_input("ScraperAPI Key", type="password", value=os.getenv("SCRAPER_API_KEY", default=""))
+    os.environ["SCRAPER_API_KEY"] = scraper_api_key
+
+    if st.button("Submit"):
+        st.session_state.api_keys = True
+        st.rerun()

src/openfactcheck/app/evaluate_response.py

@@ -1,3 +1,4 @@
+import os
 import re
 import time
 import pandas as pd

src/openfactcheck/app/sidebar.py

@@ -8,15 +8,15 @@ def sidebar():
 
     # OpenAI API Key
     st.sidebar.markdown("You can find the OpenAI API Key [here](https://platform.openai.com/account/api-keys).")
-    openai_api_key = st.sidebar.text_input("OpenAI API Key", key="openai_key", type="password", value=os.getenv("OPENAI_API_KEY"))
+    openai_api_key = st.sidebar.text_input("OpenAI API Key", key="openai_key", type="password", value=os.getenv("OPENAI_API_KEY", default=""))
     os.environ["OPENAI_API_KEY"] = openai_api_key
 
     # Serper API Key
     st.sidebar.markdown("You can find the Serper API Key [here](https://serpapi.com/dashboard).")
-    serper_api_key = st.sidebar.text_input("Serper API Key", key="serper_key", type="password", value=os.getenv("SERPER_API_KEY"))
+    serper_api_key = st.sidebar.text_input("Serper API Key", key="serper_key", type="password", value=os.getenv("SERPER_API_KEY", default=""))
     os.environ["SERPER_API_KEY"] = serper_api_key
 
-    # Azure Search Key
-    st.sidebar.markdown("You can find the Azure Search Key [here](https://portal.azure.com/).")
-    azure_search_key = st.sidebar.text_input("Azure Search Key", key="azure_key", type="password", value=os.getenv("AZURE_SEARCH_KEY"))
-    os.environ["AZURE_SEARCH_KEY"] = azure_search_key
+    # ScraperAPI Key
+    st.sidebar.markdown("You can find the ScraperAPI Key [here](https://www.scraperapi.com/).")
+    scraper_api_key = st.sidebar.text_input("ScraperAPI Key", key="scraper_key", type="password", value=os.getenv("SCRAPER_API_KEY", default=""))
+    os.environ["SCRAPER_API_KEY"] = scraper_api_key

src/openfactcheck/app/utils.py

@@ -37,36 +37,4 @@ def metric_card(
     </div>
     """
     st.markdown(html_str, unsafe_allow_html=True)
-    st.markdown('######')
-
-def footer(text: str) -> None:
-
-    style = f"""
-    <style>
-        #MainMenu {{visibility: hidden;}}
-        footer {{visibility: hidden;}}
-        .stApp {{ bottom: 52px; }}
-    </style>
-    """
-
-    st.markdown(style, unsafe_allow_html=True)
-
-    html_str = f"""
-    <div style='position: fixed;
-                left: 0;
-                bottom: 0;
-                margin: 0 0 0 0;
-                width: 100%;
-                color: black;
-                text-align: center;
-                height: auto;
-                opacity: 1'>
-        <hr style='display: block;
-                   margin: 8px 8px 8px 8px;
-                   border-style: inset;
-                   border-width: 1px' />
-        <p>{text}</p>
-    </div>
-    """
-
-    st.markdown(html_str, unsafe_allow_html=True)
+    st.markdown('######')

src/openfactcheck/lib/config.py

@@ -9,6 +9,7 @@ from collections import namedtuple
 from importlib import resources as pkg_resources
 
 from openfactcheck.lib.logger import logger, set_logger_level
+from openfactcheck.lib.utils import detect_streamlit
 from openfactcheck.errors import ConfigValidationError
 from openfactcheck import templates as solver_config_templates_dir
 from openfactcheck import solvers as solver_templates_dir
@@ -70,7 +71,7 @@ class OpenFactCheckConfig:
         # Define namedtuple structures
         Secrets = namedtuple("Secrets", ["openai_api_key", 
                                          "serper_api_key", 
-                                         "azure_search_key"])
+                                         "scraper_api_key"])
         
         # Define Attributes
         self.config = None
@@ -150,18 +151,18 @@ class OpenFactCheckConfig:
             if 'secrets' in self.config:
                 self.secrets = Secrets(openai_api_key=self.config['secrets']['openai_api_key'],
                                         serper_api_key=self.config['secrets']['serper_api_key'],
-                                        azure_search_key=self.config['secrets']['azure_search_key'])
+                                        scraper_api_key=self.config['secrets']['scraper_api_key'])
             else:
                 self.logger.warning("No secrets found in the configuration file. Make sure to set the environment variables.")
-                self.secrets = Secrets(openai_api_key=None, serper_api_key=None, azure_search_key=None)
+                self.secrets = Secrets(openai_api_key=None, serper_api_key=None, scraper_api_key=None)
         
             # Initialize Environment Variables
             if self.secrets.openai_api_key:
                 os.environ['OPENAI_API_KEY'] = self.secrets.openai_api_key
             if self.secrets.serper_api_key:
                 os.environ['SERPER_API_KEY'] = self.secrets.serper_api_key
-            if self.secrets.azure_search_key:
-                os.environ['AZURE_SEARCH_KEY'] = self.secrets.azure_search_key
+            if self.secrets.scraper_api_key:
+                os.environ['SCRAPER_API_KEY'] = self.secrets.scraper_api_key
 
             # Initialize Verbose
             if 'verbose' in self.config:
@@ -172,8 +173,9 @@ class OpenFactCheckConfig:
                 self.verbose = "INFO"
                 set_logger_level(self.logger, "INFO")
 
-            # Validate Configuration
-            self.validate()
+            # Validate the configuration
+            if not detect_streamlit():
+                self.validate()
 
             # Disable Transformers and Datasets logging
             transformers.logging.set_verbosity_error()
@@ -218,9 +220,9 @@ class OpenFactCheckConfig:
         if 'SERPER_API_KEY' not in os.environ:
             self.logger.warning("SERPER_API_KEY environment variable not found.")
             raise ConfigValidationError("SERPER_API_KEY environment variable not found.")
-        if 'AZURE_SEARCH_KEY' not in os.environ:
-            self.logger.warning("AZURE_SEARCH_KEY environment variable not found.")
-            raise ConfigValidationError("AZURE_SEARCH_KEY environment variable not found.")
+        if 'SCRAPER_API_KEY' not in os.environ:
+            self.logger.warning("SCRAPER_API_KEY environment variable not found.")
+            raise ConfigValidationError("SCRAPER_API_KEY environment variable not found.")
 
         
     

src/openfactcheck/lib/utils.py

@@ -0,0 +1,15 @@
+def detect_streamlit() -> bool:
+    try:
+        from streamlit.runtime.scriptrunner import get_script_run_ctx
+
+        if get_script_run_ctx() is not None:
+            return True
+        else:
+            return False
+        
+    except ImportError:
+        return False
+    
+    except Exception:
+        return False
+