README.md

metadata

title: EmpathemeBot
emoji: 🤖
colorFrom: indigo
colorTo: purple
sdk: streamlit
sdk_version: 1.32.0
app_file: app.py
pinned: false
license: mit

🤖 EmpathemeBot

KurageSan®による英語学習サポートAIチャットボット

概要

EmpathemeBotは、Potionベースの質問応答システムを搭載した英語学習サポートボットです。
会話履歴を保持しながら、文脈に沿った質問応答を提供します。

機能

• 📚 RAGベースの質問応答: ベクトルストアを使用した高精度な回答
• 💬 会話履歴の保持: セッション内で文脈を保持した対話
• 🎨 洗練されたUI: LINE風の吹き出しスタイルのチャットインターフェース
• 🔑 APIキー管理: OpenAI APIキーをセキュアに管理

使い方

1. APIキーの設定

   • 左上の「>」ボタンをクリックしてサイドバーを開く
   • OpenAI APIキーを入力（sk-...形式）
   • Enterキーを押して設定を保存

2. 質問を入力

   • 下部のチャット入力欄に質問を入力
   • Enterキーを押して送信

3. 新しいチャットを開始

   • サイドバーの「新しいチャット」ボタンをクリック

Hugging Face Spacesへのデプロイ

このアプリケーションはHugging Face Spaces上で動作するように最適化されています。

デプロイ手順

1. Hugging Faceアカウントの作成

   • Hugging Faceでアカウントを作成

2. 新しいSpaceの作成

   • Hugging Faceダッシュボードで「New Space」をクリック
   • Space名を入力（例：empathemebot）
   • SDKとして「Streamlit」を選択
   • Visibilityを選択（Public/Private）

3. ファイルのアップロード

   your-space/
   ├── app.py                    # メインアプリケーション
   ├── requirements.txt          # 依存関係（requirements_hf.txtの内容）
   ├── README.md                 # このファイル
   ├── src/                      # ソースコード
   │   ├── qa/
   │   │   ├── chain.py
   │   │   └── prompt.py
   │   ├── vector/
   │   │   └── ...
   │   └── ...
   └── data/                     # ベクトルストア（オプション）
       └── vector_store/
   

4. 環境変数の設定（オプション）

   • Settings → Repository secretsでOPENAI_API_KEYを設定
   • または、ユーザーが直接UIから入力

5. デプロイの確認

   • 自動的にビルドが開始されます
   • ビルドが完了すると、アプリケーションが利用可能になります

技術スタック

• フロントエンド: Streamlit
• LLMフレームワーク: LangChain
• ベクトルDB: ChromaDB
• LLM: OpenAI GPT-4

ライセンス

MIT License

開発者

Empatheme開発チーム

サポート

問題が発生した場合は、Issuesでお知らせください。

---

Note: このアプリケーションを使用するには、OpenAI APIキーが必要です。
APIキーはOpenAIのダッシュボードから取得できます。