https://github.com/ut42univ/emodialog-flask

A Personalized Diary App with Generative AI （AI分析日記アプリ）
https://github.com/ut42univ/emodialog-flask

app chat chatbot diary flask openai openai-api python

Last synced: 10 months ago
JSON representation

A Personalized Diary App with Generative AI （AI分析日記アプリ）

Host: GitHub
URL: https://github.com/ut42univ/emodialog-flask
Owner: ut42univ
License: mit
Created: 2024-04-12T04:29:55.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-07-29T09:06:12.000Z (almost 2 years ago)
Last Synced: 2025-03-11T07:49:02.303Z (over 1 year ago)
Topics: app, chat, chatbot, diary, flask, openai, openai-api, python
Language: HTML
Homepage: https://emodialog.live
Size: 53 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

          # README



[![MIT License][license-shield]][license-url]






  

    

  

  
EmoDialog

  EmotionAI for the rest of us. 

  


  

    カウンセラーAI日記アプリケーション

    


    A Personalized Diary App with Counselor AI

  



_"EmoDialog"の名前由来は，"Emo" は感情（emotion）を表し，"Dialog" は対話（dialogue）を表す言葉です．この名前は，感情を中心に据えた対話やコミュニケーションを促進するアプリケーションを示しています．感情と対話を融合させることで，ユーザーが自分の感情や思考をより深く理解し，整理する手助けをすることを意味しています．_

## プロジェクトについて（About The Project）

[![Product Name Screen Shot][product-screenshot]](https://emodialog.live)

EmoDialogは，文章生成AIを用いた個人向け日記アプリケーションです．

ユーザーが日記を書くことで，AIが感情分析を行い，ユーザーに対して返答を行います．

現在は以下の機能が実装されています:

* ユーザー登録・ログイン

* 日記の作成・編集・削除

* AIによる日記の感情分析

  * 日記から推測されるその日の感情を分析

    * 例: happy, sad, angry, etc. （ポール・エクマンの6つの基本感情に準拠）

  * 日記から推測されるその日のクオリティをスコア化（0%~100%）

    * 良い1日ならば高いスコア，悪い1日ならば低いスコア

* 感情分析結果の統計の閲覧

  * ユーザーの感情推移のグラフ表示

  * ユーザーの感情の分布の円グラフ表示

* チャットボット機能（AIによる返答）

(back to top)


### 技術スタック（Built With）

現段階で，EmoDialogは以下の技術スタックを使用して開発されています．

 [![Python][Python.org]][Python-url] [![Flask][Flask.palletsprojects]][Flask-url] [![OpenAI][openai.com]][openai-url] [![SQLite][sqllite]][sqllite-url] [![Vue][Vue.js]][Vue-url] [![Bootstrap][Bootstrap.com]][Bootstrap-url] 

(back to top)


## はじめに（Getting Started）

このプロジェクトはFlaskベースであり，サーバーでの実行を前提としていますが，Pythonの環境があればローカルでの実行も可能です．

ただし，OpenAIのAPIを使用しているため，事前にAPIキーの取得が必要です．

（※APIキーの取得にはOpenAI社へのクレジットカード情報の登録が必須です．）

またデモページも用意していますので，以下のリンクからアクセスしてみてください．

**EmoDialog(https://emodialog.live)**

_（注意: 本ページはデモ環境のため，データベースが定期的に初期化されます．）_

以下のサンプルアカウントでログインすることで，予め記録された日記や感情分析を閲覧・編集することができます．

`ユーザー名：guest`

`パスワード：psp4_sample`

### 導入（Installation）

_ここではローカル環境でのプロジェクトの導入方法について説明します．_

#### 1. OpenAI APIキーを取得し環境変数に設定する．参考 [OpenAI Platform](https://platform.openai.com)

  ```sh

  export OPENAI_API_KEY='YOUR_API_KEY'

  ```

#### 2. リポジトリをクローンする

  ```sh

  git clone https://github.com/ut42univ/EmoDialog.git

  ```

#### 3. 必要なパッケージをインストールする（仮想環境での実行を推奨）

  ```sh

  pip install -r requirements.txt

  ```

#### 4. 実行する

  ```sh

    cd app

    python app.py

  ```

#### 5. ブラウザで以下のURLにアクセスする（デフォルトはポート5000）

  ```sh

  http://localhost:5000

  ```

(back to top)


## 使用方法（Usage）

#### ユーザー登録・ログイン

  ```

  * ユーザー名とパスワードを入力して登録

  * 登録済みのユーザー名とパスワードでログイン

  ```

  ![signup](https://github.com/user-attachments/assets/9283bd3f-d2aa-40e0-ae4d-0b828d0cac31)![login](https://github.com/user-attachments/assets/c3435619-9870-4cf8-b768-c7ba204b2608)

#### 日記を作成する

  ```

  * 日記のタイトルと内容を入力して作成

  * 日記は1文字以上，500文字以下で作成可能

  ```

  ![create](https://github.com/user-attachments/assets/71748723-8d23-43b4-a240-e11c65d6ea43)

#### 日記の詳細を閲覧・編集・削除する

  ```

  * 日記の"See Detail"をクリックすることで詳細を閲覧

  * 日記の"Edit"をクリックすることで編集

  * 日記の"Delete"をクリックすることで削除

  ```

  ![delete](https://github.com/user-attachments/assets/eb875a44-6272-4c53-baab-29715d91cf76)

#### AIによる感情分析結果を閲覧する

  ```

  * ユーザーの感情推移のグラフ表示

  * ユーザーの感情の分布の円グラフ表示

  * matplotlibを使用してグラフを描画

  ```

  ![analysis](https://github.com/user-attachments/assets/27f6088c-da41-4041-931e-d1001c84e191)

#### チャットボット機能（AIによる返答）

  ```

  * EmotionAIとの会話を行う

  * "会話を終了する"で会話履歴を削除（復元できません）

  ```

  ![chat](https://github.com/user-attachments/assets/d8ddc404-0bd5-4306-b07f-bc7a19386d77)![chat_delete](https://github.com/user-attachments/assets/dfe7822d-bfe2-4413-8d71-0c55ec1e5678)

(back to top)


## ライセンス（License）

このプロジェクトはMITライセンスに準拠してOSSとして公開されています．詳細は `LICENSE` を参照してください．

Distributed under the MIT License. See `LICENSE` for more information.

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge

[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge

[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members

[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge

[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers

[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge

[issues-url]: https://github.com/othneildrew/Best-README-Template/issues

[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge

[license-url]: https://github.com/ut42univ/EmoDialog/blob/main/LICENSE

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/othneildrew

[product-screenshot]: images/screenshot.png

[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white

[Next-url]: https://nextjs.org/

[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB

[React-url]: https://reactjs.org/

[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D

[Vue-url]: https://vuejs.org/

[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white

[Angular-url]: https://angular.io/

[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00

[Svelte-url]: https://svelte.dev/

[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white

[Laravel-url]: https://laravel.com

[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white

[Bootstrap-url]: https://getbootstrap.com

[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white

[JQuery-url]: https://jquery.com 

[Python.org]: https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white

[Python-url]: https://www.python.org/

[Flask.palletsprojects]: https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white

[Flask-url]: https://flask.palletsprojects.com/

[sqllite]: https://img.shields.io/badge/SQLite-07405E?style=for-the-badge&logo=sqlite&logoColor=white

[sqllite-url]: https://www.sqlite.org/index.html

[openai.com]: https://img.shields.io/badge/OpenAI-F2F2F2?style=for-the-badge&logo=openai&logoColor=black

[openai-url]: https://www.openai.com/

[Heroku.com]: https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white

[Heroku-url]: https://www.heroku.com/

[Google Cloud]: https://img.shields.io/badge/Google_Cloud-4285F4?style=for-the-badge&logo=google-cloud&logoColor=white

[Google Cloud-url]: https://cloud.google.com/

[matplotlib]: https://img.shields.io/badge/Matplotlib-3776AB?style=for-the-badge&logo=python&logoColor=white

[matplotlib-url]: https://matplotlib.org/

[html]: https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white

[css]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/ut42univ/emodialog-flask

Awesome Lists containing this project

README

EmoDialog

EmotionAI for the rest of us.