Cricbot

Aplicación Cricbot

Descripción general

Cricbot es una aplicación de chatbot diseñada para proporcionar resultados de cricket en vivo y manejar diversas intenciones de los usuarios. Aprovecha los modelos de lenguaje de OpenAI para comprender las consultas de los usuarios y generar respuestas adecuadas. La aplicación está estructurada para garantizar la modularidad y la facilidad de mantenimiento.

Estructura del directorio

 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

Configuración

Requisitos previos

• Pitón 3.x
• pip (instalador del paquete Python)

Instalación

1. Clonar el repositorio

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

2. Crear un entorno virtual

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

3. Instalar dependencias

   pip install -r requirements.txt

4. Configurar variables de entorno

   Cree un archivo .env en el directorio raíz y agregue su clave API de OpenAI:

    OPENAI_API_KEY=your_openai_api_key_here
   

Uso

Ejecute la aplicación usando el siguiente comando:

python app/main.py

Interactúa con el bot escribiendo tus consultas. Escriba "salir" para finalizar la sesión.

Componentes

• Constantes : almacena valores constantes utilizados en toda la aplicación.
• Modelos : contiene modelos de datos como MatchDetails .
• Avisos : almacena plantillas de avisos para generar respuestas.
• Servicios : contiene la lógica central para la identificación de intenciones, la obtención de puntuaciones en vivo y la generación de respuestas.
• Utils : proporciona funciones de utilidad para tareas comunes.
• Cadenas : gestiona la secuencia de operaciones utilizando Langchain para generar respuestas.
• Enumeraciones : define las enumeraciones utilizadas en toda la aplicación.

Actualizaciones recientes

• Integración Streamlit : la aplicación ahora incluye una interfaz Streamlit para una experiencia de usuario más interactiva.
• Manejo de errores mejorado : Mecanismos de manejo de errores mejorados para una mayor confiabilidad.
• Base de código modular : código refactorizado para mejorar la legibilidad y el mantenimiento.
• Integración de Langchain : se utilizó Langchain para agilizar la secuencia de operaciones y mejorar la generación de respuestas.
• Transmisión habilitada : capacidades de transmisión agregadas para interacción en tiempo real.
• Servicio Cricbot obsoleto : reemplazado por un enfoque más modular que utiliza cadenas langchains

Mejoras futuras

• Registro : agregue registro para un mejor monitoreo y depuración.
• Pruebas : Implemente pruebas unitarias y de integración para garantizar la confiabilidad.
• Interfaz de usuario avanzada : desarrolle una GUI para una experiencia de usuario más interactiva.

Contribuyendo

¡Las contribuciones son bienvenidas! Bifurque el repositorio y envíe una solicitud de extracción para realizar mejoras o corregir errores.

Licencia

Este proyecto está bajo la licencia MIT.

---

Este archivo README proporciona una descripción general completa de la aplicación Cricbot, incluidas instrucciones de configuración, uso y mejoras futuras. No dude en modificar el contenido para adaptarlo mejor a las necesidades de su proyecto.