Cricbot

Aplikasi Cricbot

Ringkasan

Cricbot adalah aplikasi chatbot yang dirancang untuk memberikan skor kriket langsung dan menangani berbagai maksud pengguna. Ini memanfaatkan model bahasa OpenAI untuk memahami pertanyaan pengguna dan menghasilkan respons yang sesuai. Aplikasi ini disusun untuk memastikan modularitas dan kemudahan pemeliharaan.

Struktur Direktori

 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

Pengaturan

Prasyarat

• Python 3.x
• pip (penginstal paket Python)

Instalasi

1. Kloning Repositori

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

2. Ciptakan Lingkungan Virtual

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

3. Instal Dependensi

   pip install -r requirements.txt

4. Siapkan Variabel Lingkungan

   Buat file .env di direktori root dan tambahkan kunci OpenAI API Anda:

    OPENAI_API_KEY=your_openai_api_key_here
   

Penggunaan

Jalankan aplikasi menggunakan perintah berikut:

python app/main.py

Berinteraksi dengan bot dengan mengetikkan pertanyaan Anda. Ketik "exit" untuk mengakhiri sesi.

Komponen

• Konstanta : Menyimpan nilai konstanta yang digunakan di seluruh aplikasi.
• Model : Berisi model data seperti MatchDetails .
• Anjuran : Menyimpan templat cepat untuk menghasilkan tanggapan.
• Layanan : Berisi logika inti untuk identifikasi maksud, pengambilan skor langsung, dan pembuatan respons.
• Utils : Menyediakan fungsi utilitas untuk tugas-tugas umum.
• Chains : Mengelola urutan operasi menggunakan Langchain untuk menghasilkan respons.
• Enums : Mendefinisikan enumerasi yang digunakan di seluruh aplikasi.

Pembaruan Terkini

• Integrasi Streamlit : Aplikasi sekarang menyertakan antarmuka Streamlit untuk pengalaman pengguna yang lebih interaktif.
• Penanganan Kesalahan yang Ditingkatkan : Mekanisme penanganan kesalahan yang ditingkatkan untuk keandalan yang lebih baik.
• Basis Kode Modular : Kode yang difaktorkan ulang untuk meningkatkan keterbacaan dan pemeliharaan.
• Integrasi Langchain : Memanfaatkan Langchain untuk menyederhanakan urutan operasi dan meningkatkan pembangkitan respons.
• Streaming Diaktifkan : Menambahkan kemampuan streaming untuk interaksi waktu nyata.
• Layanan Cricbot yang Tidak Digunakan Lagi : Diganti dengan pendekatan yang lebih modular menggunakan langchains

Peningkatan di Masa Depan

• Logging : Tambahkan logging untuk pemantauan dan debugging yang lebih baik.
• Pengujian : Menerapkan pengujian unit dan integrasi untuk memastikan keandalan.
• Antarmuka Pengguna Tingkat Lanjut : Kembangkan GUI untuk pengalaman pengguna yang lebih interaktif.

Berkontribusi

Kontribusi dipersilakan! Silakan fork repositori dan kirimkan permintaan penarikan untuk penyempurnaan atau perbaikan bug apa pun.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT.

---

README ini memberikan gambaran komprehensif tentang aplikasi Cricbot, termasuk instruksi pengaturan, penggunaan, dan peningkatan di masa depan. Jangan ragu untuk memodifikasi konten agar lebih sesuai dengan kebutuhan proyek Anda.