Cricbot

Cricbot アプリケーション

概要

Cricbot は、ライブ クリケット スコアを提供し、さまざまなユーザーの意図を処理するように設計されたチャットボット アプリケーションです。 OpenAI の言語モデルを活用してユーザーのクエリを理解し、適切な応答を生成します。アプリケーションはモジュール化されており、メンテナンスが容易になるように構造化されています。

ディレクトリ構造

 Cricbot/
├── app/
│   ├── src/
│   │    ├── constants/
│   │    │   ├── __init__.py
│   │    │   └── constants.py
│   │    ├── models/
│   │    │   ├── __init__.py
│   │    │   └── match_details.py
│   │    ├── prompts/
│   │    │   ├── all_live_matches_response_prompt.txt
│   │    │   ├── fallback_response_prompt.txt
│   │    │   ├── intent_identifier_prompt.txt
│   │    │   └── live_score_response_prompt.txt
│   │    ├── services/
│   │    │   ├── __init__.py
│   │    │   ├── intent_identifier_service.py
│   │    │   ├── intent_handler_service.py
│   │    │   ├── live_score_service.py
│   │    │   └── response_generator_service.py
│   │    ├── utils/
│   │    │   ├── __init__.py
│   │    │   └── common_util.py
│   │    ├── chains/
│   │    │   ├── __init__.py
│   │    │   └── cricbot_chain.py
│   │    ├── enums/
│   │    │   ├── __init__.py
│   │    │   └── intents.py
│   ├── main.py
│   └── cricbot_app.py
├── .env
├── .gitignore
├── README.md
└── requirements.txt

設定

前提条件

• Python 3.x
• pip (Python パッケージ インストーラー)

インストール

1. リポジトリのクローンを作成する

   git clone https://github.com/mohitbansal964/Cricbot.git
   cd Cricbot

2. 仮想環境を作成する

   python -m venv .venv
   source .venv/bin/activate  # On Windows use `.venvScriptsactivate`

3. 依存関係のインストール

   pip install -r requirements.txt

4. 環境変数の設定

   ルート ディレクトリに.envファイルを作成し、OpenAI API キーを追加します。

    OPENAI_API_KEY=your_openai_api_key_here
   

使用法

次のコマンドを使用してアプリケーションを実行します。

python app/main.py

クエリを入力してボットと対話します。 「exit」と入力してセッションを終了します。

コンポーネント

• 定数: アプリケーション全体で使用される定数値を保存します。
• Models : MatchDetailsなどのデータ モデルが含まれます。
• Prompts : 応答を生成するためのプロンプト テンプレートを保存します。
• サービス: インテントの識別、ライブ スコアの取得、応答生成のためのコア ロジックが含まれています。
• Utils : 一般的なタスクのためのユーティリティ関数を提供します。
• Chains : 応答を生成するために Langchain を使用して一連の操作を管理します。
• Enums : アプリケーション全体で使用される列挙を定義します。

最近の更新

• Streamlit の統合: アプリケーションには、よりインタラクティブなユーザー エクスペリエンスを実現する Streamlit インターフェイスが含まれるようになりました。
• エラー処理の強化: エラー処理メカニズムが改善され、信頼性が向上しました。
• モジュラー コードベース: コードをリファクタリングして、読みやすさと保守性を向上させました。
• Langchain の統合: Langchain を利用して一連の操作を合理化し、応答生成を改善しました。
• ストリーミング有効: リアルタイム インタラクションのためのストリーミング機能が追加されました。
• 非推奨の Cricbot サービス: langchains を使用した、よりモジュール化されたアプローチに置き換えられました。

将来の機能強化

• ロギング: モニタリングとデバッグを改善するためにロギングを追加します。
• テスト: 単体テストと統合テストを実施して、信頼性を確保します。
• 高度なユーザー インターフェイス: よりインタラクティブなユーザー エクスペリエンスのための GUI を開発します。

貢献する

貢献は大歓迎です!機能拡張やバグ修正については、リポジトリをフォークしてプル リクエストを送信してください。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。

---

この README では、セットアップ手順、使用法、将来の機能拡張など、Cricbot アプリケーションの包括的な概要を説明します。プロジェクトのニーズに合わせてコンテンツを自由に変更してください。