Merge pull request #61 from barun-saha/byok

README.md

@@ -55,16 +55,6 @@ SlideDeck AI uses a subset of icons from [bootstrap-icons-1.11.3](https://github
 (CC0, MIT, and Apache licenses) are also used. 
 
 
-# Known Issues
-
-- **Model unavailable**: Mistral Nemo currently appears to be unavailable. See this [issue](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407/discussions/83).
-- **Connection timeout**: Requests sent to the Hugging Face Inference endpoint might time out. If it still does not work, wait for a while and try again.
-
-The following is not an issue but might appear as a strange behavior:
-- **Cannot paste text in the input box**: If the length of the copied text is greater than the maximum
-number of allowed characters in the textbox, pasting would not work.
-
-
 # Local Development
 
 SlideDeck AI uses LLMs via different providers, such as Hugging Face, Google, and Gemini.

app.py

@@ -82,7 +82,8 @@ def are_all_inputs_valid(
     if not llm_helper.is_valid_llm_provider_model(selected_provider, selected_model, user_key):
         handle_error(
             'The LLM settings do not look correct. Make sure that an API key/access token'
-            ' is provided if the selected LLM requires it.',
+            ' is provided if the selected LLM requires it. An API key should be 6-64 characters'
+            ' long, only containing alphanumeric characters, hyphens, and underscores.',
             False
         )
         return False
@@ -104,6 +105,14 @@ def handle_error(error_msg: str, should_log: bool):
     st.error(error_msg)
 
 
+def reset_api_key():
+    """
+    Clear API key input when a different LLM is selected from the dropdown list.
+    """
+
+    st.session_state.api_key_input = ''
+
+
 APP_TEXT = _load_strings()
 
 # Session variables
@@ -132,6 +141,7 @@ with st.sidebar:
         options=[f'{k} ({v["description"]})' for k, v in GlobalConfig.VALID_MODELS.items()],
         index=GlobalConfig.DEFAULT_MODEL_INDEX,
         help=GlobalConfig.LLM_PROVIDER_HELP,
+        on_change=reset_api_key
     ).split(' ')[0]
 
     # The API key/access token
@@ -142,6 +152,7 @@ with st.sidebar:
             ' *Optional* for HF Mistral LLMs but still encouraged.\n\n'
         ),
         type='password',
+        key='api_key_input'
     )
 
 

helpers/llm_helper.py

@@ -17,6 +17,8 @@ from global_config import GlobalConfig
 
 
 LLM_PROVIDER_MODEL_REGEX = re.compile(r'\[(.*?)\](.*)')
+# 6-64 characters long, only containing alphanumeric characters, hyphens, and underscores
+API_KEY_REGEX = re.compile(r'^[a-zA-Z0-9\-_]{6,64}$')
 HF_API_HEADERS = {'Authorization': f'Bearer {GlobalConfig.HUGGINGFACEHUB_API_TOKEN}'}
 REQUEST_TIMEOUT = 35
 
@@ -70,9 +72,14 @@ def is_valid_llm_provider_model(provider: str, model: str, api_key: str) -> bool
     if not provider or not model or provider not in GlobalConfig.VALID_PROVIDERS:
         return False
 
-    if provider in [GlobalConfig.PROVIDER_GOOGLE_GEMINI, GlobalConfig.PROVIDER_COHERE,]:
-        if not api_key or len(api_key) < 5:
-            return False
+    if provider in [
+        GlobalConfig.PROVIDER_GOOGLE_GEMINI,
+        GlobalConfig.PROVIDER_COHERE,
+    ] and not api_key:
+        return False
+
+    if api_key:
+        return API_KEY_REGEX.match(api_key) is not None
 
     return True