interface (#1)

- update (9f60a77c791d3c815b0bc6cf61a5208eeea2dcf1)
- regex update for cite sources (78be1154220dc1fe9075adb202951f0850210498)
- add .gitignore, readme (302e1248a4f5953dba50c5b4937832f42a99f016)

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.10-bookworm",
+	"features": {
+		"ghcr.io/devcontainers/features/git:1": {},
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.gitignore

@@ -0,0 +1 @@
+.devcontainer

README.md

@@ -9,4 +9,4 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+We are using this to evaluate our intelligent tutor. Please provide feedback on the bot's response to your question.

app.py

@@ -3,26 +3,25 @@ import pandas as pd
 import gspread
 from google.auth import default
 import requests
-import time 
+import time
 import json
+import re
 
 # Authenticate and authorize with Google Sheets
-#creds, _ = default()
-#gc = gspread.authorize(creds)
-gc = gspread.service_account(filename='botresponse-6f1a8c749aa0.json')
-    
+# creds, _ = default()
+# gc = gspread.authorize(creds)
+gc = gspread.service_account(filename="botresponse-6f1a8c749aa0.json")
+
 # Specify your Google Sheets credentials, sheet_id, and worksheet_name
 sheet_id = "18hnoTsEaGMWMael42MXubb-FzAe5jJB5RpaSolIXyb0"
 worksheet_name = "Sheet1"
 
+
 # Function to get the initial response
 def get_initial_response(input_message):
     url = "https://itell-api.learlab.vanderbilt.edu/chat"
 
-    payload = {
-        "textbook_name": "think-python-2e",
-        "message": input_message
-    }
+    payload = {"textbook_name": "think-python-2e", "message": input_message}
     headers = {"Content-Type": "application/json"}
 
     # Measure the start time
@@ -30,81 +29,136 @@ def get_initial_response(input_message):
 
     response = requests.post(url, json=payload, headers=headers)
     data = json.loads(response.text)
-    message = data['message']
+    message = data["message"]
+    message = message.encode("utf-8").decode("unicode_escape")
+    message = re.sub(r"^[\s'\"]*(bot)?[\s'\"]*(cite sources)?", "", message)
+    message = message.strip(" ':\"")
 
     # Calculate the elapsed time
     elapsed_time = time.time() - start_time
     elapsed_time = round(elapsed_time, 2)
-    response_time_message = f"Response time: {elapsed_time} seconds"
 
-    return message, response_time_message  # Return the initial_response and elapsed_time
+    return {
+        bot_resp: message,
+        response_time: elapsed_time,
+    }
+
 
 # Function to collect feedback and update the spreadsheet
-def feedback_response(input_message, feedback, comments):
-    # Get the initial response and elapsed_time
-    initial_response, elapsed_time = get_initial_response(input_message)
-
-    # Collect feedback
-    response = ''
-    if feedback == 'Informative':
-        response = 'Informative'
-    elif feedback == 'Inaccurate':
-        response = 'Inaccurate'
-    elif feedback == 'Nonsense':
-        response = 'Nonsense'
-    else:
-        response = 'NA'
+def feedback_response(
+    input_message,
+    bot_message,
+    response_time,
+    feedback_primary,
+    feedback_secondary,
+    comments,
+):
+    feedback = []
+    feedback.append(feedback_primary)
+    feedback.extend(feedback_secondary)
 
     # Update Google Sheets
     sh = gc.open_by_key(sheet_id)
     worksheet = sh.worksheet(worksheet_name)
-    
-    thankyou = "Thank you for your feedback. Your response and feedback has been recorded!"
-    # Append the data to the worksheet only if comments have a value
-    if comments:
-        # Create a DataFrame from the response and additional comments
-        df = pd.DataFrame({'Input Message': [input_message], 'Output': [initial_response], 'Time took in Seconds': [elapsed_time],'Feedback': [response], 'Additional Comments': [comments]})
 
-        # Append the data to the worksheet
-        worksheet.append_rows(df.values.tolist())
-        initial_response = thankyou
+    # Create a DataFrame from the response and additional comments
+    df = pd.DataFrame(
+        {
+            "Input Message": [input_message],
+            "Output": [bot_message],
+            "Time took in Seconds": [response_time],
+            "Feedback": [str(feedback)],
+            # Jaewoo, I'd prefer to have the feedback split into separate columns
+            # You would need to update the spreadsheet for this. Some of the above
+            # code could also be deleted.
+            # "Primary Feedback": [feedback_primary],
+            # "Informative": [True if any("Informative" in s for s in feedback_secondary) else False],
+            # "Inaccurate": [True if any("Inaccurate" in s for s in feedback_secondary) else False],
+            # "Nonsense": [True if any("Nonsense" in s for s in feedback_secondary) else False],
+            # "Encoding": [True if any("Encoding" in s for s in feedback_secondary) else False],
+            "Additional Comments": [comments],
+        }
+    )
 
+    # Append the data to the worksheet
+    worksheet.append_rows(df.values.tolist())
+    gr.Info("Feedback Submitted")
     
-    return initial_response, elapsed_time  # Return the initial_response and elapsed_time
-
-# Set up the Gradio Interface
-feedback_interface = gr.Interface(
-    fn=feedback_response,
-    inputs=[
-        gr.Textbox(label="Input Message"),
-        gr.Radio(
-            choices=[
-                "Informative",
-                "Inaccurate",
-                "Nonsense"
-            ],
-            label="Feedback"),
-        gr.Textbox(label="Additional Comments")
-    ],
-    outputs=[
-        gr.Textbox(label="Output", type="text"),
-        gr.Textbox(label="Elapsed Time (s)", type="text")  # Change the type to "text" for two decimal places
-    ],
-    title="Beta: Itell Guide Response Bot",
-    description="""
+    # Clear the feedback fields
+    return {
+        primary_feedback: None,
+        secondary_feedback: None,
+        additional_comments: None,
+    }
+
+
+with gr.Blocks(title="iTELL Chat Feedback") as feedback_interface:
+    title = "iTELL Chat Safety Testing"
+    gr.components.Markdown(
+        f"<h1 style='text-align: center; margin-bottom: 1rem'>{title}</h1>"
+    )
+    gr.Markdown(
+        """
     # Introduction
-    This is an interface to test iTELL's guide on the side. Please be aware that responses can take up to 20 seconds
+    This is an interface to test iTELL's guide on the side. Please be aware that responses can take up to 20 seconds.
     # Step by Step Introduction
-    1. Place a question in the input message textbox
-    2. Wait roughly 10 ~ 20 seconds for the response and elapsed time to come out on the right
-    3. After looking at the results, click on the feedback options that best describes the output: Informative, Inaccurate, Nonsense
-    4. After choosing the best option, write down additional comments for more feedback
-    5. Press submit again and wait for the output to come out again for your feedback to be submitted
-    6. Once the "Thank you for your feedback. Your response and feedback has been recorded!" message is shown, you are done
-    ** DISCLAIMER: You have to type a input message, click on the feedback buttons, and type in additional comments for your responses to be recorded
-    ** For further questions contact LEAR Labs!
+    1. Place a question in the input message textbox.
+    2. Wait 10 ~ 20 seconds for the response to appear on the right.
+    3. After looking at the results, provide primary feedback on the response.
+    4. If desired, add secondary feedback selections: Informative, Inaccurate, Nonsense.
+    4. Write down additional comments for more feedback.
+    5. Press "Submit Feedback".
     """
-)
+    )
+    elapsed_time = gr.State(0)
+    with gr.Row():
+        with gr.Column():
+            usr_msg = gr.Textbox(interactive=True, label="Input Message", lines=7)
+            response_time = gr.Number(label="Response Time", step=0.01)
+            bot_resp = gr.Textbox(label="Output", type="text", lines=10)
+            with gr.Row():
+                clear_btn = gr.ClearButton(usr_msg, value="Clear")
+                submit_btn = gr.Button("Submit")
+                # submit_btn.click(get_initial_response, inputs=usr_msg, outputs=bot_resp)
+        with gr.Column():
+            primary_feedback = gr.Radio(
+                ["👍 good", "👎 bad", "❌ inappropriate"], label="Primary Feedback"
+            )
+            secondary_feedback = gr.CheckboxGroup(
+                [
+                    "🧠 Informative",
+                    "🙅 Inaccurate",
+                    "❓ Nonsense",
+                    "🩶 Character Encoding Error",
+                ],
+                label="Secondary Feedback",
+            )
+            additional_comments = gr.Textbox(
+                label="Additional Comments", interactive=True, lines=7
+            )
+            feedback_btn = gr.Button("Submit Feedback")
+            feedback_btn.click(
+                feedback_response,
+                inputs=[
+                    usr_msg,
+                    bot_resp,
+                    response_time,
+                    primary_feedback,
+                    secondary_feedback,
+                    additional_comments,
+                ],
+                outputs=[
+                    primary_feedback,
+                    secondary_feedback,
+                    additional_comments
+                    ],
+            )
+    gr.on(
+        triggers=[submit_btn.click, usr_msg.submit],
+        fn=get_initial_response,
+        inputs=usr_msg,
+        outputs=[bot_resp, response_time],
+    )
 
 # Launch the interface
-feedback_interface.launch()
+feedback_interface.launch()