Sukoon

Project Sukoon: Mental Health Support using AI

Sukoon Pic

Open Roles for Tech Tasks

Table of Contents

Vision

Project Sukoon aims to build open-source solutions and standards for using AI to address mental health challenges. Our goal is to apply Digital Public Infrastructure (DPI) knowledge and practices to help professionals explore and understand the latest advancements in AI and their applications to mental health use-cases specific to India.

🚀 Project Progress

  1. Prototyped with Crew AI agent framework
  2. Developed backend and frontend using LangGraph framework
  3. Tried AutoGen framework but due to web UI issues, did not deployed this
  4. Completed v3 of our Sukoon chatbot and deployed in IIT Kanpur, others.
  5. Created API endpoints for LangGraph and framework for integrating with WhatsApp API

Watch the video

Installation

Technical Architecture

Technical Architecture

LangGraph (main branch )

- clone the repo and create a virutal environement. Create a `.env` file and put in your secret keys like OpenAI keys
- install all dependencies in your environment (pip install -r requirements.txt)
- To use the API, run 'python sukoon_api.py'. else run `python.py` to run it in terminal
- To use web UI, cd to `sukoon-frontend`, run 'npm start' to access it in your browser. 
- There's a newer frontend version in `frontend-vite` folder. To use this, cd to this and run `npm run dev` to view it locally.
- alternatively use this vercel deployment to access it - https://sukoon-1.vercel.app (might be stopped in future)

Steps to add environment variables -

Create a .env file with:

OPENAI_API_KEY = '<YOUR_OPENAI_API_KEY>' 
ANTHROPIC_API_KEY = '<ANTHROPIC_API_KEY>'
LANGCHAIN_API_KEY = '<YOUR_LANGCHAIN_API_KEY>'

On Windows - setx OPENAI_API_KEY “your_api_key_here”


# How to contribute 🤝
There are few ways you can contribute to Sukoon

- By providing feedback on the Sukoon Chatbot
- By helping in testing and evaluation(please find relevant code in `tests` and `evals` folder)
- By raising issues in the issues section
- By contributing to the codebase based on the issues
- Submit PRs to the respective branches (e.g. 'icg' or 'langgraph')

For detailed guidelines, please read the guidelines outlined in CONTRIBUTING.md

The docs folder contains overall project documentation and related documents. To access or contribute to the documentation, please refer to docs/README.md.
e.g Please read the main doc here and feel free to add comments here - https://docs.google.com/document/d/1H8-oJmMy0r28kYup9vqt8VGDlY_cCFW_2M07XJxWpFU/edit?usp=sharing 

## Issues

If you encounter any issues with the project, please create a new issue using the issue template. Provide as much detail as possible to help us understand and resolve the issue.

# Current Challenges
We have three active discussions:

Develop a PII Removal Module Optimizing Sukoon’s Evaluation Pipeline Improving Central Orchestrator Agent Classification in AutoGen System ```

Current Landscape

Mental health support in India faces several challenges:

What could a solution look like? (Future Vision)

Some interesting ideas to try:

“Made for 🇮🇳”