Integrate transitions state machine for addition quiz

mathtext_fastapi/conversation_manager.py

@@ -1,13 +1,21 @@
+import dill as pickle
 import os
 import json
+import random
 import requests
 
 from dotenv import load_dotenv
 from mathtext_fastapi.nlu import evaluate_message_with_nlu
+from math_quiz_fsm import MathQuizFSM
+
+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 +97,7 @@ def create_interactive_message(message_text, button_options, whatsapp_id):
     return data
 
 
-def return_next_conversational_state(context_data, user_message):
+def return_next_conversational_state(context_data, user_message, contact_uuid):
     """ Evaluates the conversation's current state to determine the next state
 
     Input
@@ -107,14 +115,32 @@ def return_next_conversational_state(context_data, user_message):
             'state': "welcome-sequence"
         }
     elif user_message == 'add':
+
+        fsm_check = SUPA.table('state_machines').select("*").eq(
+            "uuid",
+            contact_uuid
+        ).execute()
+
+        if fsm_check.data == []:
+            math_quiz_state_machine = MathQuizFSM()
+            messages = [math_quiz_state_machine.response_text]
+            dump = pickle.dumps(math_quiz_state_machine)
+
+            # TODO: Check how to save - JSONB?
+            SUPA.table('state_machines').insert(dump).execute()
+        else:
+            math_quiz_state_machine = pickle.loads(fsm_check.data['add'])
+            math_quiz_state_machine.student_answer
+            messages = math_quiz_state_machine.validate()
+            dump = pickle.dumps(math_quiz_state_machine)            
+            SUPA.table('state_machines').update(dump).eq(
+                "contact_uuid", contact_uuid
+            ).execute()
+
         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': "addition-question-sequence"
         }
     elif user_message == 'subtract':
         message_package = {
@@ -165,13 +191,15 @@ 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 = {

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,10 @@
+dill
 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,23 +28,24 @@ 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')
@@ -66,10 +67,10 @@ 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": {
@@ -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'
-# }
+# }