Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gcapella0/agente-inteligente-expedientes/llms.txt

Use this file to discover all available pages before exploring further.

Esta guía te lleva desde cero hasta tener el sistema completamente operativo. Puedes elegir entre un despliegue con Docker (recomendado para producción y entornos compartidos) o un entorno de desarrollo local con Python directamente. En ambos casos cubriremos la configuración del entorno, el primer inicio de sesión y la ejecución del pipeline de agentes.

Requisitos mínimos

Antes de comenzar, asegúrate de contar con lo siguiente:
  • Python 3.12+ — requerido para el entorno de desarrollo local
  • MongoDB 6+ — instancia local o accesible en red
  • Ghostscript — necesario para la compresión y procesamiento de PDFs
  • Ollama — únicamente si configuras LLM_PROVIDER=ollama en el archivo .env
  • Docker & Docker Compose — solo para la instalación con contenedores

Instalación

El método más rápido y reproducible. Docker Compose orquesta el contenedor de la aplicación junto con todas sus dependencias.
git clone https://github.com/gcapella0/agente-inteligente-expedientes.git
cd agente-inteligente-expedientes
cp .env.example .env
# Edit .env: JWT_SECRET_KEY, MAIL_USER, MAIL_PASS, OPENROUTER_API_KEY
mkdir -p data/input data/storage logs
docker compose build
docker compose up -d
curl http://localhost:8000/health
Una respuesta {"status": "ok"} confirma que el contenedor está en ejecución y la API responde correctamente.
Edita el archivo .env antes de ejecutar docker compose up. Como mínimo, establece un valor seguro para JWT_SECRET_KEY y las credenciales de correo (MAIL_USER, MAIL_PASS) y del proveedor LLM (OPENROUTER_API_KEY).
MongoDB 6+ debe estar corriendo de forma local o accesible en red antes de iniciar la aplicación. La configuración de Docker Compose utiliza host.docker.internal para alcanzar una instancia de MongoDB que corre en el host — si tu MongoDB está en otro servidor, actualiza MONGO_URI en .env con la dirección correspondiente.

Primeros pasos

1

Verifica que el servicio está activo

Confirma que la API responde correctamente ejecutando el endpoint de salud:
curl http://localhost:8000/health
Debes obtener la siguiente respuesta:
{"status": "ok"}
Si recibes un error de conexión, revisa los logs con docker compose logs -f (Docker) o la salida de Uvicorn (desarrollo local).
2

Obtén un token JWT

Autentícate con las credenciales del administrador para recibir un token de acceso:
curl -s -X POST http://localhost:8000/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@uneg.edu.ve", "password": "admin123"}'
La respuesta incluirá tu token de acceso junto con los datos del usuario autenticado:
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "usuario": {
    "email": "admin@uneg.edu.ve",
    "nombre_completo": "Administrador Sistema",
    "rol": "admin",
    "activo": true
  }
}
Guarda el valor de access_token — lo necesitarás para todas las llamadas a endpoints protegidos.
3

Accede a la interfaz web

Abre tu navegador y navega a:
http://localhost:8000/ui
La interfaz web integrada te permite gestionar docentes, consultar expedientes y subir documentos sin necesidad de usar la línea de comandos.
4

Explora la documentación interactiva (Swagger)

La API incluye documentación interactiva generada automáticamente con Swagger UI:
http://localhost:8000/docs
Desde aquí puedes explorar todos los endpoints disponibles, revisar los esquemas de request y response, y probar llamadas en vivo directamente desde el navegador usando el token JWT obtenido en el paso anterior.
5

Ejecuta el pipeline completo de agentes

Lanza el pipeline de cuatro agentes (WatcherAgent → OcrAgent → ClassifierAgent → StorageAgent) mediante la API. Reemplaza <TU_TOKEN> con el access_token obtenido anteriormente:
curl -s -X POST \
  "http://localhost:8000/agentes/watcher/ejecutar?modo=pipeline" \
  -H "Authorization: Bearer <TU_TOKEN>"
El sistema revisará la bandeja de entrada configurada, descargará los adjuntos nuevos y los procesará a través del pipeline completo de forma automática.
Cambia la contraseña de administrador antes de exponer el sistema en producción. Las credenciales por defecto (admin@uneg.edu.ve / admin123) son de conocimiento público. Usa el endpoint /auth/cambiar-password o la interfaz web para establecer una contraseña segura inmediatamente tras el primer inicio de sesión.

Build docs developers (and LLMs) love