Cricbot

Cricbot-Anwendung

Überblick

Cricbot ist eine Chatbot-Anwendung, die dazu dient, Live-Cricket-Ergebnisse bereitzustellen und verschiedene Benutzerabsichten zu verarbeiten. Es nutzt die Sprachmodelle von OpenAI, um Benutzeranfragen zu verstehen und entsprechende Antworten zu generieren. Die Anwendung ist so strukturiert, dass Modularität und Wartungsfreundlichkeit gewährleistet sind.

Verzeichnisstruktur

 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

Aufstellen

Voraussetzungen

• Python 3.x
• pip (Python-Paketinstallationsprogramm)

Installation

1. Klonen Sie das Repository

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

2. Erstellen Sie eine virtuelle Umgebung

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

3. Abhängigkeiten installieren

   pip install -r requirements.txt

4. Umgebungsvariablen einrichten

   Erstellen Sie eine .env Datei im Stammverzeichnis und fügen Sie Ihren OpenAI-API-Schlüssel hinzu:

    OPENAI_API_KEY=your_openai_api_key_here
   

Verwendung

Führen Sie die Anwendung mit dem folgenden Befehl aus:

python app/main.py

Interagieren Sie mit dem Bot, indem Sie Ihre Fragen eingeben. Geben Sie „exit“ ein, um die Sitzung zu beenden.

Komponenten

• Konstanten : Speichert konstante Werte, die in der gesamten Anwendung verwendet werden.
• Modelle : Enthält Datenmodelle wie MatchDetails .
• Eingabeaufforderungen : Speichert Eingabeaufforderungsvorlagen zum Generieren von Antworten.
• Dienste : Enthält die Kernlogik für die Absichtsidentifizierung, das Abrufen von Live-Scores und die Antwortgenerierung.
• Utils : Stellt Hilfsfunktionen für allgemeine Aufgaben bereit.
• Ketten : Verwaltet die Abfolge von Vorgängen mithilfe von Langchain zum Generieren von Antworten.
• Aufzählungen : Definiert Aufzählungen, die in der gesamten Anwendung verwendet werden.

Aktuelle Updates

• Streamlit-Integration : Die Anwendung enthält jetzt eine Streamlit-Schnittstelle für ein interaktiveres Benutzererlebnis.
• Verbesserte Fehlerbehandlung : Verbesserte Fehlerbehandlungsmechanismen für mehr Zuverlässigkeit.
• Modulare Codebasis : Überarbeiteter Code zur Verbesserung der Lesbarkeit und Wartbarkeit.
• Langchain-Integration : Nutzung von Langchain, um die Abfolge von Vorgängen zu rationalisieren und die Antwortgenerierung zu verbessern.
• Streaming aktiviert : Streaming-Funktionen für Echtzeitinteraktion hinzugefügt.
• Veralteter Cricbot-Dienst : Ersetzt durch einen modulareren Ansatz mit Langchains

Zukünftige Verbesserungen

• Protokollierung : Fügen Sie Protokollierung für eine bessere Überwachung und Fehlerbehebung hinzu.
• Testen : Implementieren Sie Unit- und Integrationstests, um die Zuverlässigkeit sicherzustellen.
• Erweiterte Benutzeroberfläche : Entwickeln Sie eine GUI für ein interaktiveres Benutzererlebnis.

Mitwirken

Beiträge sind willkommen! Bitte teilen Sie das Repository auf und senden Sie eine Pull-Anfrage für etwaige Verbesserungen oder Fehlerbehebungen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.

---

Diese README-Datei bietet einen umfassenden Überblick über die Cricbot-Anwendung, einschließlich Einrichtungsanweisungen, Verwendung und zukünftiger Verbesserungen. Sie können den Inhalt jederzeit ändern, um ihn besser an die Anforderungen Ihres Projekts anzupassen.