Cricbot

Application Cricbot

Aperçu

Cricbot est une application de chatbot conçue pour fournir des scores de cricket en direct et gérer diverses intentions des utilisateurs. Il exploite les modèles de langage d'OpenAI pour comprendre les requêtes des utilisateurs et générer des réponses appropriées. L'application est structurée pour garantir la modularité et la facilité de maintenance.

Structure du répertoire

 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

Installation

Conditions préalables

• Python 3.x
• pip (installateur du paquet Python)

Installation

1. Cloner le référentiel

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

2. Créer un environnement virtuel

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

3. Installer les dépendances

   pip install -r requirements.txt

4. Configurer les variables d'environnement

   Créez un fichier .env dans le répertoire racine et ajoutez votre clé API OpenAI :

    OPENAI_API_KEY=your_openai_api_key_here
   

Usage

Exécutez l'application à l'aide de la commande suivante :

python app/main.py

Interagissez avec le bot en tapant vos requêtes. Tapez « exit » pour terminer la session.

Composants

• Constantes : stocke les valeurs constantes utilisées dans l’application.
• Models : contient des modèles de données comme MatchDetails .
• Invites : stocke les modèles d’invites pour générer des réponses.
• Services : contient la logique de base pour l'identification des intentions, la récupération des scores en direct et la génération de réponses.
• Utils : Fournit des fonctions utilitaires pour les tâches courantes.
• Chaînes : Gère la séquence d'opérations à l'aide de Langchain pour générer des réponses.
• Enums : définit les énumérations utilisées dans l'application.

Mises à jour récentes

• Intégration Streamlit : L'application comprend désormais une interface Streamlit pour une expérience utilisateur plus interactive.
• Gestion améliorée des erreurs : mécanismes de gestion des erreurs améliorés pour une meilleure fiabilité.
• Base de code modulaire : code refactorisé pour améliorer la lisibilité et la maintenabilité.
• Intégration de Langchain : utilisation de Langchain pour rationaliser la séquence d'opérations et améliorer la génération de réponses.
• Streaming activé : ajout de fonctionnalités de streaming pour une interaction en temps réel.
• Service Cricbot obsolète : remplacé par une approche plus modulaire utilisant des langchains

Améliorations futures

• Journalisation : ajoutez la journalisation pour une meilleure surveillance et un meilleur débogage.
• Tests : Mettre en œuvre des tests unitaires et d'intégration pour garantir la fiabilité.
• Interface utilisateur avancée : développez une interface graphique pour une expérience utilisateur plus interactive.

Contribuer

Les contributions sont les bienvenues ! Veuillez créer le référentiel et soumettre une demande d'extraction pour toute amélioration ou correction de bugs.

Licence

Ce projet est sous licence MIT.

---

Ce README fournit un aperçu complet de l'application Cricbot, y compris les instructions de configuration, l'utilisation et les améliorations futures. N'hésitez pas à modifier le contenu pour mieux répondre aux besoins de votre projet.