improved XML prompt

config/format_mappings.py

@@ -4,37 +4,37 @@
 FORMAT_MAPPINGS_EXERCISES = {
     "Markdown": (
         "Please reformat in Markdown, following this example:\n"
-        "**Theorie:**  \n"
+        "**Theorie:**\n"
         "Eenzaamheid wordt door ieder persoon anders ervaren en is daarom subjectief.\n\n"
         "---\n\n"
-        "**Vraag:**  \n"
+        "**Vraag:**\n"
         "Wat is de meest passende definitie van eenzaamheid?\n\n"
-        "1. Het gevoel geen connectie te hebben met anderen  \n"
-        "2. Regelmatig in je eentje zijn  \n"
-        "3. Beide bovenstaande  \n"
-        "4. Geen van bovenstaande  \n\n"
-        "**Correct antwoord:**  \n"
-        "1. Het gevoel geen connectie te hebben met anderen"
+        "1. Het gevoel geen connectie te hebben met anderen\n"
+        "2. Regelmatig in je eentje zijn\n"
+        "3. Beide bovenstaande\n"
+        "4. Geen van bovenstaande\n\n"
+        "**Correct antwoord:**\n"
+        "1. Het gevoel geen connectie te hebben met anderen\n\n"
+        "**Uitleg:**\n"
+        "Connectie betekent verbinding."
     ),
     "XML": (
         "Please reformat in XML, following this example:\n"
         "<exercise>\n"
         "    <content>\n"
-        "        <question>Theorie:\n"
+        "        <prompt>Theorie:\n"
         "Eenzaamheid wordt door ieder persoon anders ervaren en is daarom subjectief.\n\n"
         "Vraag:\n"
-        "Wat is de meest passende definitie van eenzaamheid?</question>\n"
-        "        <choices>\n"
-        "            <choice id=\"1\">Het gevoel geen connectie te hebben met anderen</choice>\n"
-        "            <choice id=\"2\">Regelmatig in je eentje zijn</choice>\n"
-        "            <choice id=\"3\">Beide bovenstaande</choice>\n"
-        "            <choice id=\"4\">Geen van bovenstaande</choice>\n"
-        "        </choices>\n"
+        "Wat is de meest passende definitie van eenzaamheid?</prompt>\n"
+        "        <options>\n"
+        "            <option id=\"1\">Het gevoel geen connectie te hebben met anderen</option>\n"
+        "            <option id=\"2\">Regelmatig in je eentje zijn</option>\n"
+        "            <option id=\"3\">Beide bovenstaande</option>\n"
+        "            <option id=\"4\">Geen van bovenstaande</option>\n"
+        "        </options>\n"
         "    </content>\n"
-        "    <answer>\n"
-        "        <correct-choice>1</correct-choice>\n"
-        "        <explanation></explanation>\n"
-        "    </answer>\n"
+        "        <correct_answer>1</correct_answer>\n"
+        "        <explanation>Connectie betekent verbinding.</explanation>\n"
         "</exercise>"
     ),
     "Plaintext": (
@@ -48,7 +48,9 @@ FORMAT_MAPPINGS_EXERCISES = {
         "3. Beide bovenstaande\n"
         "4. Geen van bovenstaande\n\n"
         "Correct antwoord:\n"
-        "1. Het gevoel geen connectie te hebben met anderen"
+        "1. Het gevoel geen connectie te hebben met anderen\n\n"
+        "Extra info:\n"
+        "Connectie betekent verbinding."
     )
 }
 

config/templates.py

@@ -20,15 +20,15 @@ from config.system_prompt_texts import (
 
 template_standardize_exercise = ChatPromptTemplate(
     messages=[
-        ("system", "You reformat a given multiple choice exercise into a standardized format. {formatting_instructions}\n\n"
+        ("system", "You reformat a given multiple choice exercise into a standardized format for future human processing. {formatting_instructions}\n\n"
                    "Only 3 elements are always mandatory:\n"
                    "1. A question or statement that starts with 'Vraag:' or 'Stelling:' (or their semantic equivalents in the language of the exercise).\n"
-                   "2. A minimum of two answer options (in the spirit of 'multiple choice'), one of them the correct answer\n"
+                   "2. A minimum of two answer options (in the spirit of 'multiple choice'), one of them the correct answer.\n"
                    "3. An indication of what the correct answer is.\n\n"
                    "Always return an exercise with at least these mandatory elements. If any of the 3 elements are missing "
-                   "in the input, do your educated best to make them up. Beyond the 3 mandatory elements, never make up any "
-                   "new content that is not present in the given exercise. You should sometimes leave out certain content "
-                   "however, if there are artifacts with the given exercise that don't contribute to it."),
+                   "in the given exercise, do your educated best to make them up. Except for the 3 mandatory elements, never make up any "
+                   "new content that was not present in the given exercise. For example, if the exercise doesn't include an explanation, completely leave this out in your version as well. You should sometimes leave out certain content "
+                   "that is there, like any artifacts in the given exercise that don't contribute to its understandability."),
         ("human", "Here's the given exercise:\n{user_input}")
     ],
     input_variables=["user_input", "formatting_instructions"]