Merge branch 'feature-fsm-transitions' into 'main'

Feature fsm transitions

See merge request tangibleai/community/mathtext-fastapi!9

docs/transitions_math_quiz_example.ipynb

@@ -0,0 +1,368 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "id": "d3da0422",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import random\n",
+    "\n",
+    "from transitions import State, Machine"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "id": "07cfb740",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class MathQuizFSM(object):\n",
+    "    states = [\n",
+    "        'quiz_start', \n",
+    "        'quiz_question', \n",
+    "        'quiz_end'\n",
+    "    ]\n",
+    "\n",
+    "    transitions = [\n",
+    "        ['ask_second_question', 'quiz_start', 'quiz_question'],\n",
+    "        ['ask_next_question', 'quiz_question', 'quiz_question'],\n",
+    "        ['exit', 'quiz_start', 'quiz_end'],\n",
+    "        ['exit', 'quiz_question', 'quiz_end'],\n",
+    "    ]\n",
+    "    \n",
+    "    \n",
+    "    def __init__(self):\n",
+    "        # Instantiate the FSM\n",
+    "        self.machine = Machine(model=self, states=MathQuizFSM.states, transitions=MathQuizFSM.transitions,initial='quiz_start')\n",
+    "\n",
+    "        # Instantiate variables necessary for tracking activity\n",
+    "        self.question_nums = [2, 3]\n",
+    "        self.correct_answer = 5\n",
+    "        self.student_answer = 0\n",
+    "        self.is_correct_answer = False\n",
+    "        self.response_text = \"What is 2 + 3?\"\n",
+    "\n",
+    "        # Define transitions\n",
+    "#         self.machine.add_transition('ask_second_question', 'quiz_start', 'quiz_question')\n",
+    "#         self.machine.add_transition('ask_next_question', 'quiz_question', 'quiz_question')\n",
+    "#         self.machine.add_transition('exit', 'quiz_start', 'quiz_end')\n",
+    "#         self.machine.add_transition('exit', 'quiz_question', 'quiz_end')\n",
+    "\n",
+    "        # Define functions to run on transitions\n",
+    "        self.machine.on_enter_quiz_question('generate_math_problem')\n",
+    "        self.machine.on_exit_quiz_question('validate_answer')\n",
+    "\n",
+    "    def validate_answer(self):\n",
+    "        if self.student_answer == 'exit':\n",
+    "            self.machine.set_state('quiz_end')\n",
+    "            return [\"Come back any time!\"]\n",
+    "        elif self.correct_answer == self.student_answer:\n",
+    "            self.machine.set_state('quiz_question')\n",
+    "            self.generate_math_problem()\n",
+    "            return ['Great job!', self.response_text]\n",
+    "        else:\n",
+    "            return [\"That's not quite right.  Try again.\",self.response_text]\n",
+    "    \n",
+    "    def generate_math_problem(self):\n",
+    "        self.question_nums = random.sample(range(1,100),2)\n",
+    "        self.response_text = f\"What is {self.question_nums[0]} + {self.question_nums[1]}\"\n",
+    "        self.correct_answer = self.question_nums[0] + self.question_nums[1]\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 21,
+   "id": "ebdf92ae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "test = MathQuizFSM()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "id": "92024fcc",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'quiz_start'"
+      ]
+     },
+     "execution_count": 22,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Set as `quiz_start` due to the initial setting in Line 10\n",
+    "test.state"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 23,
+   "id": "fd1ba433",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['quiz_start', 'quiz_question', 'quiz_end']"
+      ]
+     },
+     "execution_count": 23,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Available states for the quiz module\n",
+    "test.states"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 24,
+   "id": "bb190089",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "What is 2 + 3?\n",
+      "Initial Correct Answer: 5\n",
+      "Initial Student Answer: 0\n"
+     ]
+    }
+   ],
+   "source": [
+    "# When the FSM is created, it comes with a default question/answer pair loaded\n",
+    "print(test.response_text)\n",
+    "print(f\"Initial Correct Answer: {test.correct_answer}\")\n",
+    "print(f\"Initial Student Answer: {test.student_answer}\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 25,
+   "id": "3de7c4e0",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[\"That's not quite right.  Try again.\", 'What is 2 + 3?']"
+      ]
+     },
+     "execution_count": 25,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Calling the validation fails because the answer is wrong.  The state remains the same.\n",
+    "test.validate_answer()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 26,
+   "id": "4935b470",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# The student tries again\n",
+    "test.student_answer = 5"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 27,
+   "id": "03722434",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['Great job!', 'What is 58 + 89']"
+      ]
+     },
+     "execution_count": 27,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Since the student answered correctly, MathQuizFSM generates a new math problem\n",
+    "test.validate_answer()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 28,
+   "id": "d98a4d5b",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'quiz_question'"
+      ]
+     },
+     "execution_count": 28,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# It will repeatedly re-activate the same state\n",
+    "test.state"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 29,
+   "id": "76c8a5b2",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[\"That's not quite right.  Try again.\", 'What is 58 + 89']"
+      ]
+     },
+     "execution_count": 29,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "test.validate_answer()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 30,
+   "id": "ec0a7e6a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "test.student_answer = 128"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 31,
+   "id": "a093ff27",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[\"That's not quite right.  Try again.\", 'What is 58 + 89']"
+      ]
+     },
+     "execution_count": 31,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "test.validate_answer()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 32,
+   "id": "f992d34d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "test.student_answer = 'exit'"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 33,
+   "id": "28800a2b",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['Come back any time!']"
+      ]
+     },
+     "execution_count": 33,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "test.validate_answer()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 34,
+   "id": "360ef774",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'quiz_end'"
+      ]
+     },
+     "execution_count": 34,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "test.state"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3f0392ae",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "base",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.7"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "32cf04bfac80a5e1e74e86fca42ae7f3079b15fa61041a60732bc19e88699268"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

mathtext_fastapi/conversation_manager.py

@@ -1,13 +1,24 @@
+import base64
+import dill
 import os
 import json
+import jsonpickle
+import pickle
+import random
 import requests
 
 from dotenv import load_dotenv
 from mathtext_fastapi.nlu import evaluate_message_with_nlu
+from mathtext_fastapi.math_quiz_fsm import MathQuizFSM
+from supabase import create_client
+from transitions import Machine
 
 load_dotenv()
 
-# os.environ.get('SUPABASE_URL')
+SUPA = create_client(
+    os.environ.get('SUPABASE_URL'),
+    os.environ.get('SUPABASE_KEY')
+)
 
 
 def create_text_message(message_text, whatsapp_id):
@@ -89,7 +100,13 @@ def create_interactive_message(message_text, button_options, whatsapp_id):
     return data
 
 
-def return_next_conversational_state(context_data, user_message):
+def pickle_and_encode_state_machine(state_machine):
+    dump = pickle.dumps(state_machine)
+    dump_encoded = base64.b64encode(dump).decode('utf-8')
+    return dump_encoded
+
+
+def return_next_conversational_state(context_data, user_message, contact_uuid):
     """ Evaluates the conversation's current state to determine the next state
 
     Input
@@ -106,15 +123,46 @@ def return_next_conversational_state(context_data, user_message):
             'input_prompt': "Welcome to our math practice.  What would you like to try?  Type add or subtract.",
             'state': "welcome-sequence"
         }
-    elif user_message == 'add':
+    elif context_data['state'] == 'addition-question-sequence' or \
+        user_message == 'add':
+
+        fsm_check = SUPA.table('state_machines').select("*").eq(
+            "contact_uuid",
+            contact_uuid
+        ).execute()
+
+        if fsm_check.data == []:
+            math_quiz_state_machine = MathQuizFSM()
+            messages = [math_quiz_state_machine.response_text]
+            dump_encoded = pickle_and_encode_state_machine(math_quiz_state_machine)
+
+            SUPA.table('state_machines').insert({
+                'contact_uuid': contact_uuid,
+                'addition3': dump_encoded
+            }).execute()
+        else:
+            undump_encoded = base64.b64decode(
+                fsm_check.data[0]['addition3'].encode('utf-8')
+            )
+            math_quiz_state_machine = pickle.loads(undump_encoded)
+            math_quiz_state_machine.student_answer == user_message
+            messages = math_quiz_state_machine.validate_answer()
+            dump_encoded = pickle_and_encode_state_machine(math_quiz_state_machine)          
+            SUPA.table('state_machines').update({
+                'addition3': dump_encoded
+            }).eq(
+                "contact_uuid", contact_uuid
+            ).execute()
+
+        if user_message == 'exit':
+            state_label = 'exit'
+        else:
+            state_label = 'addition-question-sequence'
+
         message_package = {
-            'messages': [
-                "Great, let's do some addition",
-                "First, we'll start with single digits.",
-                "Type your response as a number.  For example, for '1 + 1', you'd write 2."
-            ],
-            'input_prompt': "Here's the first one... What's 2+2?",
-            'state': "add-question-sequence"
+            'messages': messages,
+            'input_prompt': "temporary value",
+            'state': state_label
         }
     elif user_message == 'subtract':
         message_package = {
@@ -125,7 +173,7 @@ def return_next_conversational_state(context_data, user_message):
             'input_prompt': "Here's the first one... What's 3-1?",
             'state': "subtract-question-sequence"
         }
-    elif user_message == 'exit':
+    elif context_data['state'] == 'exit' or user_message == 'exit':
         message_package = {
             'messages': [
                 "Great, thanks for practicing math today.  Come back any time."
@@ -165,15 +213,18 @@ def manage_conversation_response(data_json):
 
     whatsapp_id = message_data['author_id']
     user_message = message_data['message_body']
+    contact_uuid = message_data['contact_uuid']
 
     # TODO: Need to incorporate nlu_response into wormhole by checking answers against database (spreadsheet?)
     nlu_response = evaluate_message_with_nlu(message_data)
 
     message_package = return_next_conversational_state(
         context_data,
-        user_message
+        user_message,
+        contact_uuid
     )
 
+
     headers = {
         'Authorization': f"Bearer {os.environ.get('TURN_AUTHENTICATION_TOKEN')}",
         'Content-Type': 'application/json'

mathtext_fastapi/math_quiz_fsm.py

@@ -0,0 +1,53 @@
+import random
+from transitions import Machine
+
+
+class MathQuizFSM(object):
+    states = [
+        'quiz_start',
+        'quiz_question',
+        'quiz_end'
+    ]
+
+    transitions = [
+        ['ask_second_question', 'quiz_start', 'quiz_question'],
+        ['ask_next_question', 'quiz_question', 'quiz_question'],
+        ['exit', 'quiz_start', 'quiz_end'],
+        ['exit', 'quiz_question', 'quiz_end'],
+    ]
+
+    def __init__(self):
+        # Instantiate the FSM
+        self.machine = Machine(
+            model=self, 
+            states=MathQuizFSM.states, 
+            transitions=MathQuizFSM.transitions,
+            initial='quiz_start'
+        )
+
+        # Instantiate variables necessary for tracking activity
+        self.question_nums = [2, 3]
+        self.correct_answer = 5
+        self.student_answer = 0
+        self.is_correct_answer = False
+        self.response_text = "What is 2 + 3?"
+
+        # Define functions to run on transitions
+        self.machine.on_enter_quiz_question('generate_math_problem')
+        self.machine.on_exit_quiz_question('validate_answer')
+
+    def validate_answer(self):
+        if self.student_answer == 'exit':
+            self.machine.set_state('quiz_end')
+            return ["Come back any time!"]
+        elif self.correct_answer == self.student_answer:
+            self.machine.set_state('quiz_question')
+            self.generate_math_problem()
+            return ['Great job!', self.response_text]
+        else:
+            return ["That's not quite right.  Try again.", self.response_text]
+    
+    def generate_math_problem(self):
+        self.question_nums = random.sample(range(1,100),2)
+        self.response_text = f"What is {self.question_nums[0]} + {self.question_nums[1]}"
+        self.correct_answer = self.question_nums[0] + self.question_nums[1]

requirements.txt

@@ -1,7 +1,11 @@
+dill
+jsonpickle
 mathtext @ git+https://gitlab.com/tangibleai/community/mathtext@main
 fastapi==0.74.*
 pydantic==1.10.*
 requests==2.27.*
 sentencepiece==0.1.*
 supabase
+transitions
 uvicorn==0.17.*
+

scripts/make_request.py

@@ -13,7 +13,7 @@ def add_message_text_to_sample_object(message_text):
     "test message"
 
     Output
-    - b_string: json b-string - an object simulating what Turn.io sends to the API endpoint using the message_text
+    - b_string: json b-string - simulated Turn.io message data
 
     Example Output
     b'{"context": "hi", "message_data": {"author_id": "+57787919091", "author_type": "OWNER", "contact_uuid": "j43hk26-2hjl-43jk-hnk2-k4ljl46j0ds09", "message_body": "test message", "message_direction": "inbound", "message_id": "4kl209sd0-a7b8-2hj3-8563-3hu4a89b32", "message_inserted_at": "2023-01-10T02:37:28.477940Z", "message_updated_at": "2023-01-10T02:37:28.487319Z"}}'
@@ -28,37 +28,38 @@ def add_message_text_to_sample_object(message_text):
     return b_string
 
 
-def run_simulated_request(endpoint, sample_answer, context = None):
+def run_simulated_request(endpoint, sample_answer, context=None):
     print(f"Case: {sample_answer}")
     b_string = add_message_text_to_sample_object(sample_answer)
 
     if endpoint == 'sentiment-analysis' or endpoint == 'text2int':
-        request = requests.post(url=
-            f'http://localhost:7860/{endpoint}',
+        request = requests.post(
+            url=f'http://localhost:7860/{endpoint}',
             json={'content': sample_answer}
         ).json()
     else:
-        request = requests.post(url=
-            f'http://localhost:7860/{endpoint}',
+        request = requests.post(
+            url=f'http://localhost:7860/{endpoint}',
             data=b_string
         ).json()
 
     print(request)
 
-run_simulated_request('sentiment-analysis', 'I reject it')
-run_simulated_request('text2int', 'seven thousand nine hundred fifty seven')
-run_simulated_request('nlu', 'test message')
-run_simulated_request('nlu', 'eight')
-run_simulated_request('nlu', 'eight, nine, ten')
-run_simulated_request('nlu', '8, 9, 10')
-run_simulated_request('nlu', '8')
-run_simulated_request('nlu', "I don't know")
-run_simulated_request('nlu', 'Today is a wonderful day')
-run_simulated_request('nlu', 'IDK 5?')
-run_simulated_request('manager', '')
+
+# run_simulated_request('sentiment-analysis', 'I reject it')
+# run_simulated_request('text2int', 'seven thousand nine hundred fifty seven')
+# run_simulated_request('nlu', 'test message')
+# run_simulated_request('nlu', 'eight')
+# run_simulated_request('nlu', 'eight, nine, ten')
+# run_simulated_request('nlu', '8, 9, 10')
+# run_simulated_request('nlu', '8')
+# run_simulated_request('nlu', "I don't know")
+# run_simulated_request('nlu', 'Today is a wonderful day')
+# run_simulated_request('nlu', 'IDK 5?')
+# run_simulated_request('manager', '')
 run_simulated_request('manager', 'add')
-run_simulated_request('manager', 'subtract')
-run_simulated_request('manager', 'exit')
+# run_simulated_request('manager', 'subtract')
+# run_simulated_request('manager', 'exit')
 
 
 # Example of simplified object received from Turn.io stacks
@@ -66,12 +67,12 @@ run_simulated_request('manager', 'exit')
 # NOTE: This is actually a bstring, not a dict
 simplified_json = {
     "context": {
-        "user":"+57787919091", 
-        "state":"answer-addition-problem", 
-        "bot_message":"What is 2+2?", 
-        "user_message":"eight",
+        "user": "+57787919091", 
+        "state": "answer-addition-problem", 
+        "bot_message": "What is 2+2?", 
+        "user_message": "eight",
         "type": "ask"
-    }, 
+    },
     "message_data": {
         "author_id": "+57787919091", 
         "author_type": "OWNER", 
@@ -85,7 +86,6 @@ simplified_json = {
 }
 
 
-
 # Full example of event data from Turn.io 
 # simplified_json is built from this in Turn.io
 # full_json = {
@@ -144,4 +144,4 @@ simplified_json = {
 #         'type': 'text'
 #     },
 #     'type': 'message'
-# }
+# }