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”以終止會話。

成分

• 常數：儲存在應用程式中使用的常數值。
• 模型：包含資料模型，例如MatchDetails 。
• 提示：儲存用於產生回應的提示範本。
• 服務：包含意圖辨識、即時比分獲取和回應產生的核心邏輯。
• Utils ：為常見任務提供實用函數。
• Chains ：使用 Langchain 管理操作序列以產生回應。
• Enums ：定義在應用程式中使用的枚舉。

最近更新

• Streamlit 整合：該應用程式現在包含 Streamlit 介面，以提供更具互動性的使用者體驗。
• 增強的錯誤處理：改進的錯誤處理機制以提高可靠性。
• 模組化程式碼庫：重構程式碼以增強可讀性和可維護性。
• Langchain 整合：利用 Langchain 簡化操作順序並改進回應產生。
• 啟用串流媒體：新增了即時互動的串流功能。
• 已棄用的 Cricbot 服務：替換為使用 langchains 的更模組化的方法

未來的增強功能

• 日誌記錄：新增日誌記錄以更好地監控和調試。
• 測試：實施單元和整合測試以確保可靠性。
• 進階使用者介面：開發 GUI 以提供更具互動性的使用者體驗。

貢獻

歡迎貢獻！請分叉存儲庫並提交請求以獲取任何增強功能或錯誤修復。

執照

該項目已獲得 MIT 許可證的許可。

---

本自述文件提供了 Cricbot 應用程式的全面概述，包括設定說明、用法和未來的增強功能。請隨意修改內容以更好地滿足您的專案需求。