💬 PUE-BE

💕 AI 심리상담 챗봇 PUE

퓨처로이컴퍼니
프로젝트 시작 : 2022.08

힘든 사람 누구에게나 친구가 되어줄
따듯한 위로를 전하는 AI 챗봇 서비스

🥇 Goals

코로나 블루로 우울감을 호소하는 사람이 많아지자 상담사 고용을 늘렸지만 여전히 응답률이 저조하였습니다.
이를 위해 정보 제공용 챗봇을 뛰어넘어 가벼운 심리 상담이 가능한 챗봇을 만들고자 하였습니다.
상담이 여려운 시간대에도 상담이 가능하며 챗봇 상담의 높은 접근성으로 기존 상담에 대한 인식을 개선하고자 개발하게 되었습니다.

🔨 Environments

Language

<<<<<<< HEAD

Framework

Library

Framework

Library

• Check your socketio version compatibility in HERE

>>>>>>> 970c54cb57e1c660b01219880a0d5a35e81dda2e

Communication

File structure

│
├─models
│  ├─user         
│  ├─chat        
│  └─statistic
│
├─packages
│  └─pue_AI           //submodule of PUE-AI
│
├─resources
│  ├─chat
│  ├─chatnamespace    //real-time chat resources with SocketIo
│  ├─user
│  ├─statistic
│  └─oauth
│
└──app                //RESTful API server

<<<<<<< HEAD

Environments

Development

Language & Framework

Library

Communication

Project Settings

=======

⚙️ Project Settings

970c54cb57e1c660b01219880a0d5a35e81dda2e

Essential Required dependency's version

python >= 3.8.x
flask-socketio >= 5.x

<<<<<<< HEAD

• Check your socketio version compatibility in HERE =======

970c54cb57e1c660b01219880a0d5a35e81dda2e

Install packages dependencies

> pip install -r requirements.txt

Start server

python3 app.py

Start in background

nohup python3 -u app.py &

#To take look into logs
tail -f nohup.out

#To shut down server
lsof -i :5000
sudo kill -9 <task-pid>

<<<<<<< HEAD

Auto Setup Feature

=======

📜 Auto Setup Feature

970c54cb57e1c660b01219880a0d5a35e81dda2e PUE-AI is implanted into this project as submodule.
It has functions which will setup your environmental variables automatically.

Environment Variable

function : setup_environ

• Initiating with PUE-AI package, it will have set your environment variable first.

this_dir, this_filename = os.path.split(__file__)

os.environ['CHATBOT_ROOT'] = this_dir

print("Environment Variable Set Successfully. root: %s" % (os.environ['CHATBOT_ROOT'])) 

Download pretrained weights

function : download_weights

• Initiating with PUE-AI package, it will have get weights from this drive.

 if not os.path.exists(weight_path+"/Emo_weights") :
        os.makedirs(weight_path+"/Emo_weights")

    if not os.path.isfile(weight_path+"/Emo_weights/Emo_weights.index") or Emo_flag:
        print("Downloading Emo pretrained index...")
        output = weight_path+"/Emo_weights/Emo_weights.index"
        gdown.download(loaded["EMO-index-url"], output, quiet=False)

<<<<<<< HEAD

Model and Resources description

=======

📜 Model and Resources description

970c54cb57e1c660b01219880a0d5a35e81dda2e Detailed descripions are in our WIKI.

DB Models

Managed and Controlled with SQLAchemy

User

• User's personal information table
• Relationships(has 2 child table)
  • Chat table(child) : chatlog
  • Statistic table(child) : number of user's daily emotion

Chat

• User's chatbot logs(encrypted)
• Relationships(has 1 parent table)
  • User table(parent)

Statistic

• User's number of user's daily emotion logs(encrypted)
• Relationships(has 1 parent table)
  • User table(parent)

Resources

Apis coming through endpoints are processed by (RESTful)resources

Authorization

• User must have JWT to idenify their account.

Find by day range

• Every resources have range method, which can get charts in multiple sqeuntial dates.

#request url example
curl --location --request GET 'http://133.186.215.54:5001//stat/latest/20220910/before/7'

#response example in statistic resource.
{
    "isSummary": true,
    "summary": {
        "total": 0,
        "emotions": {
            "불만": 0,
            "중립": 1,
            "당혹": 0,
            "기쁨": 0,
            "걱정": 0,
            "질투": 0,
            "슬픔": 1,
            "죄책감": 0,
            "연민": 0
        }
    },
    "statistics": [
        {
            "date": "20220906",
            "chart": {
                "total": 0,
                "emotions": {
                    "불만": 0,
                    "중립": 1,
                    "당혹": 0,
                    "기쁨": 0,
                    "걱정": 0,
                    "질투": 0,
                    "슬픔": 0,
                    "죄책감": 0,
                    "연민": 0
                }
            }
        },
        {
            "date": "20220908",
            "chart": {
                "total": 0,
                "emotions": {
                    "불만": 0,
                    "중립": 0,
                    "당혹": 0,
                    "기쁨": 0,
                    "걱정": 0,
                    "질투": 0,
                    "슬픔": 1,
                    "죄책감": 0,
                    "연민": 0
                }
            }
        }
    ]
}

Find by number

• Every resources have number method, which can get charts in past sqeuntial dates.

#request url example
curl --location --request GET 'http://133.186.215.54:5001//chats/latest/20220910235700/number/4'

#response example in statistic resource.
{
  "chats": [
    {
      "day": "20220910",
      "time": "235645",
      "direction": "BOT",
      "utterance": "네, 좋은 밤 되세요."
    },
    {
      "day": "20220910",
      "time": "235640",
      "direction": "USER",
      "utterance": "내일 봐!"
    },
    {
      "day": "20220908",
      "time": "020030",
      "direction": "BOT",
      "utterance": "무슨 일이 있으신가요??"
    },
    {
      "day": "20220908",
      "time": "020022",
      "direction": "USER",
      "utterance": "나 우울해..."
    }
  ]
}

<<<<<<< HEAD

DOCUMENTAION

It might be worse, if you're missing out our WIKI!.

LICENSE

=======

📚 Documentations

• Branch Strategy

• Git Convention

• Coding Convention

• Workflow

🔒 LICENSE

Preparing...

970c54cb57e1c660b01219880a0d5a35e81dda2e