Serenity

Índice

• Descripción del Proyecto
• Características Principales
• Instalación
• Imágenes
• Contribución

Descripción del Proyecto

El proyecto es una implementación de inteligencia artificial destinada a crear expertos virtuales en diversas áreas con el objetivo de ayudar a las empresas a optimizar su trabajo. Esta solución permite interactuar con dichos expertos a través de chat, enfocándose específicamente en la capacidad de leer y analizar archivos en formato PDF. De esta manera, se facilita la colaboración y el procesamiento de información contenida en documentos PDF para obtener resultados más eficientes y precisos.

Características Principales

• Interacción en tiempo real: Los usuarios pueden chatear directamente con los expertos virtuales, realizando consultas, obteniendo recomendaciones y recibiendo respuestas de manera instantánea.
• Embeddings de contenido: Mediante técnicas de procesamiento de lenguaje natural y aprendizaje automático, el proyecto realiza embeddings de los archivos y mensajes enviados, lo que permite una mejor comprensión y análisis del contenido.
• Optimización del trabajo: Al contar con expertos virtuales especializados, las empresas pueden mejorar la eficiencia y calidad de su trabajo al tener acceso a conocimientos y recomendaciones específicas en tiempo real.

El proyecto combina las tecnologías de inteligencia artificial, procesamiento de lenguaje natural y análisis de datos para crear una solución completa y versátil que brinda asistencia experta a las empresas en diversas áreas.

Instalación

Sigue los siguientes pasos para instalar y configurar el proyecto en tu entorno local:

1. Clona el repositorio en tu máquina local utilizando el siguiente comando:

git clone https://github.com/angxdes/Serenity

2. Accede al directorio del proyecto:

cd Serenity/Serenity

3. Crea un entorno virtual utilizando venv (asegúrate de tener Python 3 instalado):

python3 -m venv venv o python -m venv venv

4. Activa el entorno virtual:
• En macOS y Linux:

source venv/bin/activate

• En Windows:

venv\Scripts\activate

5. Instala las dependencias necesarias:

python -m pip install -r requirements.txt

6. Crea la BD

python manage.py migrate

7. ¡Listo! Ahora puedes ejecutar el proyecto utilizando el siguiente comando:

python3 manage.py runserver

O

python manage.py runserver

Imágenes

A continuación, se muestran algunos screenshots y el diagrama de la base de datos para que puedas tener una vista previa de cómo se ve el proyecto en acción:

Screenshot 1 - Chat

Screenshot 2 - Funcionalidad

Screenshot 3 - Página Principal

Diagrama de la Base de Datos

El diagrama de la base de datos muestra la relación entre las diferentes tablas utilizadas en el proyecto. Esto proporciona una visión general de cómo se almacenan y organizan los datos.

Esperamos que estas imágenes te den una mejor idea de cómo funciona el proyecto y cómo se presenta ante los usuarios. ¡Disfruta explorando las diversas funcionalidades y características que ofrece Serenity!

Contribución

¡Gracias por tu interés en contribuir a este proyecto! A continuación, se presentan algunas pautas para ayudarte a empezar:

• Si encuentras un error o tienes una idea para una mejora, por favor, abre un issue en el repositorio. Asegúrate de proporcionar detalles claros y concisos sobre el problema o la sugerencia.
• Si deseas trabajar en una tarea existente, comenta en el issue correspondiente para informar a los demás de tu intención y evitar duplicados de esfuerzo.
• Si deseas contribuir con código, sigue estos pasos:
  1. Haz un fork de este repositorio y clónalo en tu máquina local.
  2. Crea una nueva rama para tu contribución: git checkout -b mi-contribucion.
  3. Realiza tus cambios y asegúrate de que el código sigue las convenciones de estilo existentes.
  4. Realiza commits descriptivos y claros.
  5. Envía un pull request a la rama main de este repositorio, describiendo los cambios realizados y cualquier información relevante.
• Se valoran y aprecian todas las contribuciones, ya sea en forma de código, documentación, corrección de errores, pruebas, sugerencias o comentarios.

Agradecemos mucho todas las contribuciones, grandes o pequeñas. Juntos podemos hacer crecer este proyecto y mejorar su funcionalidad para beneficiar a la comunidad.

¡Disfruta del proyecto!