Add example prompt to demo

app.py

@@ -12,7 +12,17 @@ openai.api_key = os.environ.get("OPENAI_API_KEY")
 
 
 def create_prompt(sentence, paraphrase_type):
-    prompt = {
+    """
+    Creates a prompt for generating a paraphrase of a given sentence with specified types.
+
+    Args:
+        sentence (str): The original sentence to be paraphrased.
+        paraphrase_type (str): The type of paraphrase to be generated.
+
+    Returns:
+        dict: A dictionary containing the prompt message.
+    """
+    return {
         "messages": [
             {
                 "role": "user",
@@ -24,7 +34,6 @@ def create_prompt(sentence, paraphrase_type):
             }
         ]
     }
-    return prompt
 
 
 paraphrase_types = [
@@ -72,7 +81,7 @@ with gr.Blocks() as demo:
     chatbot = gr.Chatbot()
     types = gr.Dropdown(
         paraphrase_types,
-        value="Modal Verb Changes",
+        value="Syntax/discourse structure changes",
         multiselect=True,
         allow_custom_value=True,
     )
@@ -81,21 +90,65 @@ with gr.Blocks() as demo:
     clear = gr.Button("Clear")
 
     def user(user_message, history):
+        """
+        This function takes in a user message and a history of previous messages, and returns an empty string and an updated history list with the user message appended to it.
+
+        Args:
+        - user_message (str): The message sent by the user.
+        - history (list): A list of previous messages, where each message is a list containing the message text and the bot's response.
+
+        Returns:
+        - A tuple containing an empty string and the updated history list.
+        """
         return "", history + [[user_message, None]]
 
     def generate_paraphrase(user_message, paraphrase_type, history):
-        history[-1][1] = ""
+        """
+        Generates a paraphrase of the user's message using OpenAI's GPT-3 model.
+
+        Args:
+            user_message (str): The message to be paraphrased.
+            paraphrase_type (str): The type of paraphrase to generate.
+            history (list): A list of previous messages in the conversation.
+
+        Yields:
+            list: A list of previous messages in the conversation, including the new paraphrase.
+        """
+        types_as_str = ",".join(paraphrase_type)
+        history[-1][1] = f"[System: {types_as_str}]\n\n"
         prompt = create_prompt(history[-1][0], paraphrase_type)
         bot_message = openai.ChatCompletion.create(
             model="ft:gpt-3.5-turbo-0613:personal::7xbU0xQ2",
             messages=prompt["messages"],
         )
-        history[-1][1] = ""
         for character in bot_message.choices[0].message.content:
             history[-1][1] += character
             time.sleep(0.01)
             yield history
 
+    chatbot.value = [
+        [
+            (
+                "These outlined a"
+                " theory of the photoelectric effect, explained Brownian"
+                " motion, introduced his special theory of relativity—a theory"
+                " which addressed the inability of classical mechanics to"
+                " account satisfactorily for the behavior of the"
+                " electromagnetic field—and demonstrated that if the special"
+                " theory is correct, mass and energy are equivalent to each"
+                " other."
+            ),
+            (
+                "[System: Syntax/discourse structure changes]\n\nAnother of"
+                " the papers introduced Einstein's special theory of"
+                " relativity, which addressed the inability of classical"
+                " mechanics to account for the behavior of the electromagnetic"
+                " field, and demonstrated that, if the special theory is"
+                " correct, mass and energy are equivalent to each other."
+            ),
+        ]
+    ]
+
     msg.submit(user, [msg, chatbot], [msg, chatbot], queue=False).then(
         generate_paraphrase, [msg, types, chatbot], chatbot
     )