WellCareBot: Mental Health Chatbot

This project implements a mental health chatbot using advanced language models and various tools to provide empathetic, professional, and evidence-based support to users seeking help with their mental health and emotional well-being.

Table of Contents

1. Project Overview
2. Features
3. Prerequisites
4. Installation
5. Backend Setup
6. Frontend Setup
7. Usage
8. Project Structure
9. Configuration
10. API Endpoints
11. Contributing

Project Overview

The WellCareBot is designed to act as a virtual psychotherapist, utilizing a combination of cognitive-behavioral therapy (CBT), interpersonal therapy (IPT), psychodynamic therapy, and supportive therapy. It uses advanced language models and specialized tools to provide personalized support and information to users.

Features

• Empathetic and professional responses to user queries
• Integration of multiple therapeutic approaches
• Use of specialized tools for retrieving mental health information and conducting web searches
• Flask-based API for easy integration into web applications
• Persistence of conversation threads
• Streaming responses for a more dynamic user experience
• Flutter-based mobile application for user interaction
• Integration with Twilio for WhatsApp communication

Prerequisites

Backend

• Python 3.7+
• OpenAI API key
• Tavily API key
• Pinecone API key
• Groq API key (if using Groq models)
• Twilio Account SID, Auth Token, and Phone Number

Frontend

• Flutter SDK
• Android Studio or VS Code with Flutter extension
• A device or emulator to run the application

Installation

Backend Setup

1. Clone the repository:

   git clone https://github.com/katendejericho5/mental-health-chatbot.git
   cd mental-health-chatbot/backend

2. Install the required packages:

   pip install -r requirements.txt

3. Set up your environment variables by creating a .env file in the backend directory:

   OPENAI_API_KEY=your_openai_api_key
   TAVILY_API_KEY=your_tavily_api_key
   PINECONE_API_KEY=your_pinecone_api_key
   GROQ_API_KEY=your_groq_api_key
   TWILIO_PHONE_NUMBER=your_twilio_phone_number
   TWILIO_ACCOUNT_SID=your_twilio_account_sid
   TWILIO_AUTH_TOKEN=your_twilio_auth_token

4. To start the Flask server, run:

   python main.py

The server will start on http://localhost:5000 by default.

Frontend Setup

1. Clone the repository (if not already done):

   git clone https://github.com/katendejericho5/mental-health-chatbot.git
   cd mental-health-chatbot/frontend

2. Ensure you have the Flutter SDK installed. If not, follow the official installation guide.

3. Install the required dependencies:

   flutter pub get

4. Run the application on an emulator or connected device:

   flutter run

5. Link to the APK via Google Drive:

   https://drive.google.com/drive/folders/1M1rfdRwTkqWhKcJbs5asiiVXlEfZZZ3o?usp=sharing

Usage

Backend

To start the Flask server:

python main.py

The server will start on http://localhost:5000 by default.

Frontend

To run the Flutter application:

flutter run

Project Structure

Backend

• backend/main.py: Main Flask application with routes and logic
• backend/graph.py: Defines the conversation flow graph
• backend/tools.py: Implements specialized tools for information retrieval
• backend/functions.py: Utility functions for environment setup and message formatting
• backend/agents.py: Defines the AI assistant and language model setup
• backend/retrieval.py: Handles document retrieval from Pinecone

Frontend

• frontend/lib/: Contains the Flutter application code
• frontend/lib/screens/: UI screens of the application
• frontend/lib/widgets/: Custom widgets used in the application
• frontend/lib/services/: Services for API calls and data handling

Configuration

Backend

Ensure you have set up the following in your .env file:

• OPENAI_API_KEY: Your OpenAI API key
• TAVILY_API_KEY: Your Tavily API key for web searches
• PINECONE_API_KEY: Your Pinecone API key for vector storage
• GROQ_API_KEY: Your Groq API key (if using Groq models)
• TWILIO_PHONE_NUMBER: Your Twilio phone number
• TWILIO_ACCOUNT_SID: Your Twilio Account SID
• TWILIO_AUTH_TOKEN: Your Twilio Auth Token

Frontend

Ensure you have set up the following in your .env file:

• API_BASE_URL: Base URL of the backend API (e.g., http://localhost:5000)

API Endpoints

Create a New Thread

• URL: /thread
• Method: GET
• Response: JSON object with a thread_id

Send a Message (Therapist)

• URL: /chat/therapist
• Method: POST
• Body:

  {
    "message": "User's message",
    "thread_id": "UUID of the conversation thread",
    "email": "User's email"
  }

• Response: JSON object with the AI's response

Send a Message (Companion)

• URL: /chat/companion
• Method: POST
• Body:

  {
    "message": "User's message",
    "thread_id": "UUID of the conversation thread"
  }

• Response: JSON object with the AI's response

Renew Rate Limit

• URL: /renew-rate-limit
• Method: POST
• Response: JSON object with a success message

WhatsApp Integration

• URL: /whatsapp
• Method: POST
• Body: Form data with Body and From
• Response: Twilio MessagingResponse

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.