Update demo.py

demo.py

@@ -1,6 +1,10 @@
+import datetime
 import os
+import json
 import gradio as gr
 import requests
+import firebase_admin
+from firebase_admin import db, credentials
 
 def clamp(x, minimum, maximum):
     return max(minimum, min(x, maximum))
@@ -10,12 +14,23 @@ def clamp(x, minimum, maximum):
 #################################################################################################################################################
 
 # read secret api key
-API_KEY = os.getenv('ApiKey')
+API_KEY = os.environ['ApiKey']
+FIREBASE_API_KEY = os.environ['FirebaseSecret']
+FIREBASE_URL = os.environ['FirebaseURL']
+
+creds = credentials.Certificate(json.loads(FIREBASE_API_KEY))
+firebase_app = firebase_admin.initialize_app(creds, {'databaseURL': FIREBASE_URL})
+firebase_data_ref = db.reference("data")
+firebase_current_ref = None
+
 
 base_url = "https://skapi.polyglot-edu.com/"
 levels = ["Pre K", "Primary", "Middle School", "High School", "Academic"]
 
 def get_level_mapping(level):
+    if level is None:
+        raise gr.Error("Please select a level.")
+
     return {
         "Academic": 0,
         "Pre K": 1,
@@ -56,25 +71,41 @@ def generate_fill_gaps(original_text, level, number_of_words, number_of_gaps, nu
         case "≈ 350 Words":
             number_of_words = 350
 
-    response = requests.post(
-        base_url + "FillTheGaps/generateexercise",
-        headers={
-            "ApiKey": API_KEY
-        },
-        json={
-            "text": original_text,
-            "level": get_level_mapping(level),
-            "n_o_w": int(number_of_words),
-            "n_o_g": int(number_of_gaps),
-            "n_o_d": int(number_of_distractors),
-            "temperature": int(temperature) * 0.2
-        },
-        timeout=20
-    )
-
-    if response.status_code == 200:
-        return response.text
-    raise Exception(f"API call failed with status code {response.status_code} and message {response.text}")
+    input_json = {
+        "text": original_text,
+        "level": get_level_mapping(level),
+        "n_o_w": int(number_of_words),
+        "n_o_g": int(number_of_gaps),
+        "n_o_d": int(number_of_distractors),
+        "temperature": int(temperature) * 0.2
+    }
+
+    output = ""
+    try:
+        response = requests.post(
+            base_url + "FillTheGaps/generateexercise",
+            headers={"ApiKey": API_KEY},
+            json=input_json,
+            timeout=20
+        )
+
+        if response.status_code != 200:
+            output = f"API call failed with status code {response.status_code} and message '{response.text}'"
+            raise Exception(f"API call failed with status code {response.status_code} and message '{response.text}'")
+        
+        output = response.text
+        return output
+    finally:
+        global firebase_current_ref
+        firebase_current_ref = firebase_data_ref.push({
+            "type": "fill_the_gaps",
+            **input_json,
+            "output": output,
+            "datetime": str(datetime.datetime.now()),
+            "like": 0,
+            "comment_text": "",
+            "flagged": False,
+        })
 
 def generate_open_question(original_text, level, temperature):
     """
@@ -94,22 +125,38 @@ def generate_open_question(original_text, level, temperature):
         The open question.
     """
 
-    response = requests.post(
-        base_url + "QuestionExercise/generateexercise",
-        headers={
-            "ApiKey": API_KEY
-        },
-        json={
-            "text": original_text,
-            "level": get_level_mapping(level),
-            "temperature": int(temperature) * 0.2
-        },
-        timeout=20
-    )
-
-    if response.status_code == 200:
-        return response.text
-    raise Exception(f"API call failed with status code {response.status_code} and message {response.text}")
+    input_json = {
+        "text": original_text,
+        "level": get_level_mapping(level),
+        "temperature": int(temperature) * 0.2
+    }
+
+    output = ""
+    try:
+        response = requests.post(
+            base_url + "QuestionExercise/generateexercise",
+            headers={"ApiKey": API_KEY},
+            json=input_json,
+            timeout=20
+        )
+
+        if response.status_code != 200:
+            output = f"API call failed with status code {response.status_code} and message '{response.text}'"
+            raise Exception(f"API call failed with status code {response.status_code} and message '{response.text}'")
+        
+        output = response.text
+        return output
+    finally:
+        global firebase_current_ref
+        firebase_current_ref = firebase_data_ref.push({
+            "type": "open_question",
+            **input_json,
+            "output": output,
+            "datetime": str(datetime.datetime.now()),
+            "like": 0,
+            "comment_text": "",
+            "flagged": False,
+        })
 
 def generate_multiplechoice(original_text, level, number_of_options, number_of_easy_distractors, number_of_distractors, temperature):
     """
@@ -135,34 +182,95 @@ def generate_multiplechoice(original_text, level, number_of_options, number_of_e
         The multiple-choice question.
     """
     
-    response = requests.post(
-        base_url + "QuizExercise/generateexercise",
-        headers={
-            "ApiKey": API_KEY
-        },
-        json={
-            "text": original_text,
-            "type": True,
-            "level": get_level_mapping(level),
-            "n_o_d": int(number_of_distractors),
-            "nedd": int(number_of_easy_distractors),
-            "temperature": int(temperature) * 0.2
-        },
-        timeout=20
-    )
+    input_json = {
+        "text": original_text,
+        "type": True,
+        "level": get_level_mapping(level),
+        "n_o_d": int(number_of_distractors),
+        "nedd": int(number_of_easy_distractors),
+        "temperature": int(temperature) * 0.2
+    }
+
+    output = ""
+    try:
+        response = requests.post(
+            base_url + "QuizExercise/generateexercise",
+            headers={"ApiKey": API_KEY},
+            json=input_json,
+            timeout=20
+        )
+
+        if response.status_code != 200:
+            output = f"API call failed with status code {response.status_code} and message '{response.text}'"
+            raise Exception(f"API call failed with status code {response.status_code} and message '{response.text}'")
+        
+        output = response.text
+        return output
+    finally:
+        global firebase_current_ref
+        firebase_current_ref = firebase_data_ref.push({
+            "type": "open_question",
+            **input_json,
+            "output": output,
+            "datetime": str(datetime.datetime.now()),
+            "like": 0,
+            "comment_text": "",
+            "flagged": False,
+        })
+
+def like():
+    global firebase_current_ref
+    if firebase_current_ref is not None:
+        firebase_current_ref.update({"like": 1})
+        gr.Info("Generated text liked.")
+    else:
+        gr.Warning("No generated text to vote.")
+
+def neutral_like():
+    global firebase_current_ref
+    if firebase_current_ref is not None:
+        firebase_current_ref.update({"like": 0})
+        gr.Info("Generated text preference removed.")
+    else:
+        gr.Warning("No generated text to vote.")
+
+def dislike():
+    global firebase_current_ref
+    if firebase_current_ref is not None:
+        firebase_current_ref.update({"like": -1})
+        gr.Info("Generated text disliked.")
+    else:
+        gr.Warning("No generated text to vote.")
+
+def comment(comment_text):
+    global firebase_current_ref
+    if firebase_current_ref is not None:
+        firebase_current_ref.update({"comment": comment_text})
+        gr.Info("Comment added.")
+    else:
+        raise gr.Error("No generated text to comment.")
+
+def flag(flag_btn):
+    global firebase_current_ref
+    if firebase_current_ref is not None:
+        firebase_current_ref.update({"flagged": not firebase_current_ref.get()["flagged"]})
+        if firebase_current_ref.get()["flagged"]:
+            gr.Info("Generated text flagged.")
+            value = "⚠️  Unflag"
+        else:
+            gr.Info("Generated text unflagged.")
+            value = "⚠️  Flag"
+        return gr.Button(value=value)
+    else:
+        gr.Warning("No generated text to flag.")
+
+    return flag_btn
 
-    if response.status_code == 200:
-        return response.text
-    raise Exception(f"API call failed with status code {response.status_code} and message {response.text}")
 
 #################################################################################################################################################
 # Interface building
 #################################################################################################################################################
 
-flag_link = "https://www.google.com"
-comment_link = "https://www.google.com"
-
-
 def build_fill_gaps_interface():
     """
     Build the fill-gaps interface.
@@ -174,10 +282,10 @@ def build_fill_gaps_interface():
                 submit_btn = gr.Button(value="Submit")
             with gr.Column(scale=4):
                 output_text_length = gr.Radio(["≈ 150 Words", "≈ 250 Words", "≈ 350 Words"], label="Output text length", value="≈ 150 Words")
-                level = gr.Radio(levels, label="Level", value="Primary")
+                level = gr.Radio(levels, label="Level")
                 with gr.Row():
                     blanks = gr.Number(value=5, minimum=4, maximum=8, step=1, label="Number of blanks")
-                    distractors = gr.Number(value=5, minimum=4, maximum=8, step=1, label="Number of distractors")
+                    distractors = gr.Number(value=2, minimum=0, maximum=5, step=1, label="Number of distractors")
                 temperature = gr.Checkbox(value=False, label="Increase creativity (decreases preciseness)")
 
                 def update_numeric(output_text_length, blanks, distractors):
@@ -203,11 +311,20 @@ def build_fill_gaps_interface():
             output = gr.TextArea(placeholder="Generated text", label="Output")
         with gr.Row() as button_row:
             upvote_btn = gr.Button(value="👍  Upvote")
+            remove_preference_btn = gr.Button(value="Remove Preference")
             downvote_btn = gr.Button(value="👎  Downvote")
-            comment_btn = gr.Button(value="💬 Comment", link=comment_link)
-            flag_btn = gr.Button(value="⚠️  Flag", link=flag_link)
+            flag_btn = gr.Button(value="⚠️  Flag")
+        gr.Markdown("<hr/>")
+        with gr.Row():
+            comment_text = gr.TextArea(placeholder="Comment", label="Leave a comment about the generated text", scale=6)
+            comment_btn = gr.Button(value="💬 Comment", scale=2)
 
         submit_btn.click(generate_fill_gaps, [input_field, level, output_text_length, blanks, distractors, temperature], [output])
+        upvote_btn.click(like)
+        remove_preference_btn.click(neutral_like)
+        downvote_btn.click(dislike)
+        comment_btn.click(comment, [comment_text])
+        flag_btn.click(flag, [flag_btn], [flag_btn])
 
         return demo
 
@@ -221,7 +338,7 @@ def build_multiplechoice_interface():
                 input_field = gr.TextArea(lines=10, max_lines=10, label="Input text (can be a text or a url)")
                 submit_btn = gr.Button(value="Submit")
             with gr.Column(scale=4):
-                level = gr.Radio(levels, label="Level", value="Primary")
+                level = gr.Radio(levels, label="Level")
                 with gr.Row():
                     options = gr.Number(value=4, minimum=2, maximum=8, step=1, label="Number of blanks", interactive=False)
                     easy_distractors = gr.Number(value=1, minimum=0, maximum=8, step=1, label="Number of easy distractors")
@@ -249,11 +366,20 @@ def build_multiplechoice_interface():
             output = gr.TextArea(placeholder="Generated text", label="Output")
         with gr.Row() as button_row:
             upvote_btn = gr.Button(value="👍  Upvote")
+            remove_preference_btn = gr.Button(value="Remove Preference")
             downvote_btn = gr.Button(value="👎  Downvote")
-            comment_btn = gr.Button(value="💬 Comment", link=comment_link)
-            flag_btn = gr.Button(value="⚠️  Flag", link=flag_link)
+            flag_btn = gr.Button(value="⚠️  Flag")
+        gr.Markdown("<hr/>")
+        with gr.Row():
+            comment_text = gr.TextArea(placeholder="Comment", label="Comment", scale=6)
+            comment_btn = gr.Button(value="💬 Comment", scale=2)
 
         submit_btn.click(generate_multiplechoice, [input_field, level, options, easy_distractors, distractors, temperature], [output])
+        upvote_btn.click(like)
+        remove_preference_btn.click(neutral_like)
+        downvote_btn.click(dislike)
+        comment_btn.click(comment, [comment_text])
+        flag_btn.click(flag, [flag_btn], [flag_btn])
 
         return demo
 
@@ -267,7 +393,7 @@ def build_open_question_interface():
                 input_field = gr.TextArea(lines=10, max_lines=10, label="Input text (can be a text or a url)")
                 submit_btn = gr.Button(value="Submit")
             with gr.Column(scale=4):
-                level = gr.Radio(levels, label="Level", value="Primary")
+                level = gr.Radio(levels, label="Level")
                 with gr.Row():
                     pass
                 temperature = gr.Checkbox(value=False, label="Increase creativity (decreases preciseness)")
@@ -275,11 +401,20 @@ def build_open_question_interface():
             output = gr.TextArea(placeholder="Generated text", label="Output")
         with gr.Row() as button_row:
             upvote_btn = gr.Button(value="👍  Upvote")
+            remove_preference_btn = gr.Button(value="Remove Preference")
             downvote_btn = gr.Button(value="👎  Downvote")
-            comment_btn = gr.Button(value="💬 Comment", link=comment_link)
-            flag_btn = gr.Button(value="⚠️  Flag", link=flag_link)
+            flag_btn = gr.Button(value="⚠️  Flag")
+        gr.Markdown("<hr/>")
+        with gr.Row():
+            comment_text = gr.TextArea(placeholder="Comment", label="Comment", scale=6)
+            comment_btn = gr.Button(value="💬 Comment", scale=2)
 
         submit_btn.click(generate_open_question, [input_field, level, temperature], [output])
+        upvote_btn.click(like)
+        remove_preference_btn.click(neutral_like)
+        downvote_btn.click(dislike)
+        comment_btn.click(comment, [comment_text])
+        flag_btn.click(flag, [flag_btn], [flag_btn])
 
         return demo