Added basic assessment service to chatbot.

Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1
 
-FROM python:3.9
+FROM python:3.10
 
 WORKDIR /code
 

app.py

@@ -1,13 +1,16 @@
-from datetime import datetime, timedelta
+from datetime import datetime
 from flask import Flask, request, jsonify, make_response
 from flask_cors import CORS
 from datetime import datetime
 import openai
 import os
+import random
+import therapist
 
 ### VARIABLES
 
 INITIAL_MESSAGE = "Hi! I'm Brainy, a virtual assistant who can guide you through the mental health screening process. Can you start by telling me a bit about the problems you are experiencing?"
+HASH_LENGTH = 12
 
 #### SET UP ENVIRONMENT
 openai.api_key = os.getenv("OPENAI_API_KEY")
@@ -18,20 +21,6 @@ CORS(app)
 users = {}
 message_history = {}
 
-### RESPONSE FUNCTIONS
-
-def generate_response(prompt):
-    completions = openai.Completion.create(
-        engine = "text-davinci-003",
-        prompt = prompt,
-        max_tokens = 1024,
-        n = 1,
-        stop = None,
-        temperature=0.5,
-    )
-    message = completions.choices[0].text.strip()
-    return message
-
 ### UTILITY FUNCTIONS
 
 def clean_users(users=users, message_history=message_history):
@@ -48,33 +37,33 @@ def index():
 
 @app.route('/get_initial', methods=['GET'])
 def get_initial():
-    response = INITIAL_MESSAGE
+    response = therapist.initial_message
     
     connect_time = datetime.now()
-    user_id = str(hash(connect_time))
+    user_id = str("%030x" % random.randrange(16 ** HASH_LENGTH))[-HASH_LENGTH:]
     
-    users[user_id] = (connect_time)
-    message_history[user_id] = [INITIAL_MESSAGE]
+    users[user_id] = {
+        "user_id": user_id,
+        "connect_time": connect_time,
+        "state": ["initial"],
+        "message_history": [therapist.initial_message]}
 
     clean_users() # Remove old user IDs and messages from our system
     
     return jsonify({"response": response, "user_id":user_id})
 
-@app.route('/reset_cookie', methods=['GET'])
-def reset_cookie():
-    # Set cookie value to an empty string
-    resp = make_response("Cookie reset")
-    resp.set_cookie('last_index', '', expires=datetime.now() - timedelta(days=1))
-    return resp
-
 @app.route('/get_response', methods=['GET'])
 def get_response():
     message = request.args.get("message")
     user_id = request.args.get("user_id")
-    
-    response = generate_response(message)
-    
-    message_history[user_id].extend([message, response])
+    user = users[user_id]
+
+    if not message.strip():
+        response = "Please enter a message."
+    else:
+        state, response = therapist.generate_response(user, message)
+        user["state"] = state
+        user["message_history"].extend([message, response])
     
     return jsonify({"response": response})
 

questionnaires.py

@@ -0,0 +1,35 @@
+import json
+
+FILE_PATH = "static/questionnaires/"
+END = "<end>"
+
+with open(FILE_PATH+"index.json", "r") as fh:
+    index = json.load(fh)
+
+topics = list(index.keys())
+
+questionnaires = {}
+for topic, filename in index.items():
+    with open(FILE_PATH+filename, "r") as fh:
+        questionnaires[topic] = json.load(fh)
+
+numbers = {
+    topic: [question["number"] for question in questionnaires[topic]["questions"]] + [END]
+    for topic
+    in topics
+    }
+sections = {
+    topic: [question["section"] for question in questionnaires[topic]["questions"]] + [END]
+    for topic
+    in topics
+    }
+questions = {
+    topic: [question["text"] for question in questionnaires[topic]["questions"]] + [END]
+    for topic
+    in topics
+    }
+scales = {
+    topic: [question["scale"] for question in questionnaires[topic]["questions"]] + [END]
+    for topic
+    in topics
+    }

static/questionnaires/index.json

@@ -0,0 +1,7 @@
+{
+    "depression": "questionnaire_phq-9.json",
+    "anxiety": "questionnaire_gad-7.json",
+    "adhd": "questionnaire_asrs-5.json",
+    "ocd": "questionnaire_zf-ocs.json",
+    "ptsd": "questionnaire_pc-ptsd.json"
+}

static/questionnaires/questionnaire_asrs-5.json

@@ -0,0 +1,93 @@
+{
+    "name": "ASRS-5",
+    "description": null,
+    "questions": [
+        {
+            "number": 1,
+            "section": 1,
+            "text": "Over the past six months, how often have you had difficulty concentrating on what people are saying to you even when they are speaking to you directly?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        },
+        {
+            "number": 2,
+            "section": 1,
+            "text": "Over the past six months, how often have you left your seat in meetings or other situations in which you are expected to remain seated?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        },
+        {
+            "number": 3,
+            "section": 1,
+            "text": "Over the past six months, how often have you had difficulty unwinding and relaxing when you have time to yourself?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        },
+        {
+            "number": 4,
+            "section": 1,
+            "text": "Over the past six months, how often have you found yourself finishing the sentences of the people you are talking to before they can finish them themselves when you're in a conversation?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        },
+        {
+            "number": 5,
+            "section": 1,
+            "text": "Over the past six months, how often have you put things off until the last minute?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        },
+        {
+            "number": 6,
+            "section": 1,
+            "text": "Over the past six months, how often have you depended on others to keep your life in order and attend to details?",
+            "scale": {
+                "Never": 0,
+                "Rarely": 1,
+                "Sometimes": 2,
+                "Often": 3,
+                "Very Often": 4
+            }
+        }
+    ],
+    "scoring": [
+        {
+            "section": 1,
+            "ranges": [
+                [0,14],
+                [14,25]
+            ],
+            "severity": [
+                "Does not screen positive",
+                "Screens positive"
+            ]
+        }
+    ], 
+    "source": "https://www.hcp.med.harvard.edu/ncs/ftpdir/adhd/ASRS-5_English.pdf",
+    "accessed": "2023-03-25"
+}

static/questionnaires/questionnaire_gad-7.json

@@ -0,0 +1,113 @@
+{
+    "name": "GAD-7",
+    "description": null,
+    "questions": [
+        {
+            "number": 1,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by feeling nervous, anxious, or on edge?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 2,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by not being able to stop or control worrying?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 3,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by worrying too much about different things?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 4,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by trouble relaxing?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 5,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by being so restless that it is hard to sit still?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 6,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by becoming easily annoyed or irritable?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 7,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by feeling afraid, as if something awful might happen?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 8,
+            "section": 2,
+            "text": "How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?",
+            "scale": {
+                "Not difficult at all": 0,
+                "Somewhat difficult": 1,
+                "Very difficult": 2,
+                "Extremely difficult": 3
+            }
+        }
+    ],
+    "scoring": [
+        {
+            "section": 1,
+            "ranges": [
+                [0,5],
+                [5,10],
+                [10,15],
+                [15,22]
+            ],
+            "severity": [
+                "Minimal",
+                "Mild",
+                "Moderate",
+                "Severe"
+            ]
+        }
+    ], 
+    "source": "https://adaa.org/sites/default/files/GAD-7_Anxiety-updated_0.pdf",
+    "accessed": "2023-03-25"
+}

static/questionnaires/questionnaire_pc-ptsd.json

@@ -0,0 +1,73 @@
+{
+    "name": "ZF-OCS",
+    "description": null,
+    "questions": [
+        {
+            "number": 1,
+            "section": 1,
+            "text": "Sometimes things happen to people that are unusually or especially frightening, horrible, or traumatic. For example:, a serious accident or fire, a physical or sexual assault or abuse, an earthquake or flood, a war, seeing someone be killed or seriously injured, having a loved one die through homicide or suicide. Have you ever experienced this kind of event?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 2,
+            "section": 2,
+            "text": "In the past month, have you had nightmares about the event or thought about the event when you did not want to?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 3,
+            "section": 2,
+            "text": "In the past month, have you tried hard not to think about the event or went out of your way to avoid situations that reminded you of the event?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 4,
+            "section": 2,
+            "text": "In the past month, have you been constantly on guard, watchful, or easily startled?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 5,
+            "section": 2,
+            "text": "In the past month, have you felt numb or detached from people, activities, or your surroundings?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 6,
+            "section": 2,
+            "text": "In the past month, have you felt guilty or unable to stop blaming yourself or others for the event(s) or any problems the event(s) may have caused?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        }
+    ],
+    "scoring": [
+        {
+            "section": 2,
+            "ranges": [
+                [0,1]
+            ],
+            "severity": [
+                "Positive for PTSD symptoms"
+            ]
+        }
+    ], 
+    "source": "https://www.ptsd.va.gov/professional/assessment/screens/pc-ptsd.asp",
+    "accessed": "2023-03-25"
+}

static/questionnaires/questionnaire_phq-9.json

@@ -0,0 +1,144 @@
+{
+    "name": "PHQ-9",
+    "description": null,
+    "questions": [
+        {
+            "number": 1,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by having little interest or pleasure in doing things?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 2,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by feeling down, depressed, or hopeless?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 3,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by having trouble falling or staying asleep, or sleeping too much?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 4,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by feeling tired or having little energy?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 5,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by having poor appetite or overeating?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 6,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by feeling bad about yourself - or that you are a failure or have let yourself or your family down?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 7,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by having trouble concentrating on things, such as reading the newspaper or watching television?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 8,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by moving or speaking so slowly that other people could have noticed? Or the opposite - being so fidgety or restless that you have been moving around a lot more than usual?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 9,
+            "section": 1,
+            "text": "Over the last two weeks, how often have you been bothered by having thoughts that you would be better off dead or of hurting yourself in some way?",
+            "scale": {
+                "Not at all": 0,
+                "Several days": 1,
+                "More than half the days": 2,
+                "Nearly every day": 3
+            }
+        },
+        {
+            "number": 10,
+            "section": 1,
+            "text": "How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?",
+            "scale": {
+                "Not difficult at all": 0,
+                "Somewhat difficult": 1,
+                "Very difficult": 2,
+                "Extremely difficult": 3
+            }
+        }
+    ],
+    "scoring": [
+        {
+            "section": 1,
+            "ranges": [
+                [0,5],
+                [5,10],
+                [10,15],
+                [15,20],
+                [20,28]
+            ],
+            "severity": [
+                "None-minimal",
+                "Mild",
+                "Moderate",
+                "Moderately severe",
+                "Severe"
+            ],
+            "action": [
+                "Patient may not need depression treatment",
+                "Use clinical judgment about treatment, based on patient's duration of symptoms and functional impairment",
+                "Use clinical judgment about treatment, based on patient's duration of symptoms and functional impairment",
+                "Treat using antidepressants, psychotherapy or a combination of treatment",
+                "Treat using antidepressants with or without psychotherapy"
+            ]
+        }
+    ], 
+    "source": "https://www2.gov.bc.ca/assets/gov/health/practitioner-pro/bc-guidelines/depression_patient_health_questionnaire.pdf",
+    "accessed": "2023-03-25"
+}

static/questionnaires/questionnaire_zf-ocs.json

@@ -0,0 +1,72 @@
+{
+    "name": "ZF-OCS",
+    "description": null,
+    "questions": [
+        {
+            "number": 1,
+            "section": 1,
+            "text": "Do you wash or clean a lot?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 2,
+            "section": 1,
+            "text": "Do you check things a lot?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 3,
+            "section": 1,
+            "text": "Is there any thought that keeps bothering you that you would like to get rid of, but can't?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 4,
+            "section": 1,
+            "text": "Do your daily activities take a long time to finish?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 5,
+            "section": 1,
+            "text": "Are you concerned about orderliness or symmetry?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 6,
+            "section": 1,
+            "text": "Have you depended on others to keep your life in order and attend to details?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        },
+        {
+            "number": 7,
+            "section": 2,
+            "text": "Do these problems trouble you?",
+            "scale": {
+                "No": 0,
+                "Yes": 1
+            }
+        }
+    ],
+    "scoring": null,
+    "source": "https://www.ementalhealth.ca/index.php?m=survey&ID=13",
+    "accessed": "2023-03-25"
+}

therapist.py

@@ -0,0 +1,106 @@
+import openai
+import os
+import questionnaires
+
+initial_message = "Hi! I'm Brainy, a virtual assistant who can help you through the mental health screening process. Can you start by telling me a bit about the problems you are experiencing?"
+services = "https://www.canada.ca/en/public-health/topics/mental-health-wellness.html"
+
+openai.api_key = os.getenv("OPENAI_API_KEY")
+
+available_questionnaires = list(questionnaires.topics)
+
+def listify(options: list, lower=True):
+    if len(options) > 1: options[-1] = "and " + options[-1]
+    if lower is True: options = list(map(str.lower, options))
+    return ", ".join(options) if len(options) > 2 else " ".join(options)
+
+def content_summarizer():
+    pass
+
+def assess_response(question: str, response:str, options: list, uses_scale=True, context="a psychological evaluation"):
+    context_prompt = "" if context=="" else f"The context of this discussion is {context}. "
+    if uses_scale is True:
+        prompt = context_prompt + f"""
+        Given the question '{question}' and this response to the question '{response}', rate the response on the following scale: {", ".join(map("'{}'".format, options))}. 
+        Return only the corresponding scale item and nothing else.
+        """
+    else:
+        prompt = context_prompt + f"""
+        Given the question '{question}' and this response to the question '{response}', which of the following is the response most similar to? {", ".join(map("'{}'".format, options))}. 
+        Return only the most similar item and nothing else.
+        """
+    response = openai.Completion.create(
+        model="text-davinci-003",
+        prompt=prompt,
+        temperature=0.1,
+        max_tokens=10
+    )
+    return response.choices[0].text.strip()
+
+def yes_no(message):
+    return assess_response(question="Yes or No?", response=message, options=["Yes", "No"], context="", uses_scale=False)
+
+def questionnaire_chooser(message):
+    topic = assess_response(
+        question = initial_message,
+        response = message,
+        options = available_questionnaires + ["Suicidal", "None of the previously mentioned options"],
+        uses_scale = False
+        )
+
+    match topic.lower():
+        case "suicidal":
+            state = ["initial"]
+            response = f"""
+                It sounds like you are in a crisis, or require immediate assistance. If this is the case, please call 911.
+                If would like to know more, resources can be found here: {services}.
+                """
+        case "none of the previously mentioned options": 
+            state = ["initial"]
+            response = f"""
+                At the moment I can only help with {listify(available_questionnaires)}.
+                If you are in a crisis, or require immediate assistance, please call 911.
+                If you are looking for help with another mental health topic, more resources can be found here: {services}.
+                """
+        case _:
+            state = ["potential", topic.lower()]
+            response = f"It sounds like you're having trouble with {topic.lower()}. Is that correct?" 
+    
+    return state, response
+
+def bot_response(next_question=None):
+    pass
+
+def get_question(questionnaire, number):
+    print(questionnaire, number)
+    return questionnaires.questions[questionnaire][number]
+
+def generate_response(user, message):
+    
+    user_id, state = user["user_id"], user["state"]
+
+    match state[0]:    
+        case "initial":
+            state, response = questionnaire_chooser(message)
+        
+        case "potential":
+            if yes_no(message) == "Yes": 
+                state = ["screening", state[1], 1]
+                response = get_question(state[1], 0)
+            else:
+                state, response = ["initial"], "I think I misunderstood you. Let's try again... can you please tell me about the problems you are experiencing?"
+
+        case "screening":
+            state, question = state, get_question(state[1], state[2])
+            
+            if question == questionnaires.END:
+                state = ["finished"]
+                response = f"I have finished my evaluation, and that is all I can do for you today. Please refresh my page if you would like to start again. If you would like to give your clinician access to my assessment, please give them reference number #{user_id}."
+            else: 
+                state[2] += 1
+                response = question
+
+        case "finished":
+            state, response = state, None
+
+    return state, response