add error checking

app.py

@@ -1,85 +1,121 @@
 import gradio as gr
-import os 
+import os
+import requests
 
-from helpers import make_header, upload_file, request_transcript, wait_for_completion, make_paragraphs_string
+from helpers import (
+    make_header,
+    upload_file,
+    request_transcript,
+    wait_for_completion,
+    make_paragraphs_string,
+)
 
 
 title = """<h1 align="center">🔥AssemblyAI: Conformer-1 Demo🔥</h1>"""
 
-subtitle = """<h2 align="center">Automatic Speech Recognition using the AssemblyAI API</h2>"""
+subtitle = (
+    """<p align="center">Automatic Speech Recognition using the AssemblyAI API</p>"""
+)
 link = """<p align="center"><a href="https://www.assemblyai.com/blog/conformer-1/">Click here to learn more about the Conformer-1 model</a></p>"""
 
 
-def submit_to_AAI(api_key,
-                  radio,
-                  audio_file,
-                  mic_recording):
+def submit_to_AAI(api_key, radio, audio_file, mic_recording):
 
     if radio == "Audio File":
         audio_data = audio_file
     elif radio == "Record Audio":
         audio_data = mic_recording
-        
+
+    if not api_key:
+        return "Error! Did you use a valid API key?"
+
     header = make_header(api_key)
-        
+
     # 1. Upload the audio
-    upload_url = upload_file(audio_data, header, is_file=False)
+    try:
+        upload_url = upload_file(audio_data, header, is_file=False)
+    except requests.exceptions.HTTPError:
+        return "Error! Did you use a valid API key?"
+    except requests.exceptions.ConnectionError:
+        return "Error! Did you use a valid API key?"
+
+    # if upload_url is None:
+    #    return "Error: Did you set a valid API key?"
 
     # 2. Request transcript
     transcript_response = request_transcript(upload_url, header)
-    
-    transcript_id = transcript_response['id']
-    
+
+    transcript_id = transcript_response["id"]
+
     # 3. Wait for the transcription to complete
     _, error = wait_for_completion(transcript_id, header)
-    
+
     if error is not None:
         return error
 
-    # 4. Fetch paragraphs of transcript    
+    # 4. Fetch paragraphs of transcript
     return make_paragraphs_string(transcript_id, header)
 
 
 def change_audio_source(radio):
     if radio == "Audio File":
-        return [gr.Audio.update(visible=True),
-                gr.Audio.update(visible=False)]
+        return [gr.Audio.update(visible=True), gr.Audio.update(visible=False)]
     elif radio == "Record Audio":
-        return [gr.Audio.update(visible=False),
-                gr.Audio.update(visible=True)]
-                
-with gr.Blocks(css = """#col_container {width: 1000px; margin-left: auto; margin-right: auto;}
-                #chatbot {height: 520px; overflow: auto;}""") as demo:
-    gr.HTML('<center><a href="https://www.assemblyai.com/"><img src="file/images/logo.png" width="180px"></a></center>')
+        return [gr.Audio.update(visible=False), gr.Audio.update(visible=True)]
+
+
+with gr.Blocks(
+    css="""#col_container {width: 1000px; margin-left: auto; margin-right: auto;}
+                #chatbot {height: 520px; overflow: auto;}"""
+) as demo:
+    gr.HTML(
+        '<center><a href="https://www.assemblyai.com/"><img src="file/images/logo.png" width="180px"></a></center>'
+    )
     gr.HTML(title)
     gr.HTML(subtitle)
     gr.HTML(link)
-    gr.HTML('''<center><a href="https://huggingface.co/spaces/assemblyai/Conformer1-Demo?duplicate=true"><img src="https://bit.ly/3gLdBN6" alt="Duplicate Space"></a>Duplicate the Space and run securely with your AssemblyAI API Key</center>''')
-       
+    gr.HTML(
+        """<center><a href="https://huggingface.co/spaces/assemblyai/Conformer1-Demo?duplicate=true"><img src="https://bit.ly/3gLdBN6" alt="Duplicate Space"></a>Duplicate the Space and run securely with your AssemblyAI API Key</center>"""
+    )
+
     with gr.Column(elem_id="col_container"):
-        api_key = gr.Textbox(type='password', label="Enter your AssemblyAI API key here")
-        
+        api_key = gr.Textbox(
+            type="password", label="Enter your AssemblyAI API key here"
+        )
+
         with gr.Box():
             # Selector for audio source
-            radio = gr.Radio(["Audio File", "Record Audio"], label="Audio Source", value="Audio File")    
+            radio = gr.Radio(
+                ["Audio File", "Record Audio"], label="Audio Source", value="Audio File"
+            )
             # Audio object for both file and microphone data
             audio_file = gr.Audio()
             mic_recording = gr.Audio(source="microphone", visible=False)
-        
-            gr.Examples([os.path.join(os.path.dirname(__file__),"audio/audio.mp3")], audio_file)
-        
+
+            gr.Examples(
+                [
+                    os.path.join(os.path.dirname(__file__), "audio/audio.mp3"),
+                    os.path.join(os.path.dirname(__file__), "audio/gettysburg10.wav"),
+                ],
+                audio_file,
+            )
+
         btn = gr.Button("Run")
-        
-        out = gr.Textbox(placeholder="Your formatted transcript will appear here ...", lines=10)
-        
+
+        out = gr.Textbox(
+            placeholder="Your formatted transcript will appear here ...", lines=10
+        )
+
         # Changing audio source changes Audio input component
-        radio.change(fn=change_audio_source,
-                    inputs=[radio],
-                    outputs=[audio_file, mic_recording])
-            
+        radio.change(
+            fn=change_audio_source, inputs=[radio], outputs=[audio_file, mic_recording]
+        )
+
         # Clicking "submit" uploads selected audio to AssemblyAI, performs requested analyses, and displays results
-        btn.click(fn=submit_to_AAI,
-                inputs=[api_key,radio,audio_file,mic_recording],
-                outputs=out)
+        btn.click(
+            fn=submit_to_AAI,
+            inputs=[api_key, radio, audio_file, mic_recording],
+            outputs=out,
+        )
 
-    demo.launch(debug=True)
+    demo.launch(debug=True)

helpers.py

@@ -9,10 +9,7 @@ transcript_endpoint = "https://api.assemblyai.com/v2/transcript"
 
 
 def make_header(api_key):
-    return {
-        'authorization': api_key,
-        'content-type': 'application/json'
-    }
+    return {"authorization": api_key, "content-type": "application/json"}
 
 
 def _read_file(filename, chunk_size=5242880):
@@ -46,7 +43,7 @@ def upload_file(audio_file, header, is_file=True):
     upload_response = requests.post(
         upload_endpoint,
         headers=header,
-        data=_read_file(audio_file) if is_file else _read_array(audio_file)
+        data=_read_file(audio_file) if is_file else _read_array(audio_file),
     )
     if upload_response.status_code != 200:
         upload_response.raise_for_status()
@@ -59,18 +56,16 @@ def request_transcript(upload_url, header):
 
     # If input is a dict returned from `upload_file` rather than a raw upload_url string
     if type(upload_url) is dict:
-        upload_url = upload_url['upload_url']
+        upload_url = upload_url["upload_url"]
 
     # Create request
     transcript_request = {
-        'audio_url': upload_url,
+        "audio_url": upload_url,
     }
 
     # POST request
     transcript_response = requests.post(
-        transcript_endpoint,
-        json=transcript_request,
-        headers=header
+        transcript_endpoint, json=transcript_request, headers=header
     )
 
     return transcript_response.json()
@@ -79,14 +74,14 @@ def request_transcript(upload_url, header):
 def wait_for_completion(transcript_id, header):
     """Given a polling endpoint, waits for the transcription/audio analysis to complete"""
     polling_endpoint = "https://api.assemblyai.com/v2/transcript/" + transcript_id
-    
+
     while True:
         polling_response = requests.get(polling_endpoint, headers=header)
         polling_response = polling_response.json()
 
-        if polling_response['status'] == 'completed':
+        if polling_response["status"] == "completed":
             return polling_response, None
-        elif polling_response['status'] == 'error':
+        elif polling_response["status"] == "error":
             return None, f"Error: {polling_response['error']}"
 
         time.sleep(5)
@@ -94,5 +89,5 @@ def wait_for_completion(transcript_id, header):
 
 def make_paragraphs_string(transc_id, header):
     endpoint = transcript_endpoint + "/" + transc_id + "/paragraphs"
-    paras = requests.get(endpoint, headers=header).json()['paragraphs']
-    return '\n\n'.join(i['text'] for i in paras)
+    paras = requests.get(endpoint, headers=header).json()["paragraphs"]
+    return "\n\n".join(i["text"] for i in paras)