cortex-knowledge-assistant

Cortex Knowledge Assistant - Documentación

Sistema RAG de nivel empresarial con protección de datos sensibles

Inicio Rápido • Arquitectura • API Reference • Configuración • Seguridad • Despliegue • Desarrollo

---

Índice de Documentación

Guías Principales

Documento	Descripción	Audiencia
Inicio Rápido	Instalación y primer uso en menos de 5 minutos	Todos
Guías de Usuario	Uso del sistema por rol (Customer, Employee, Admin)	Usuarios finales
Arquitectura	Diseño técnico, componentes y flujo de datos	Arquitectos, Desarrolladores Senior
API Reference	Referencia completa de endpoints REST	Desarrolladores
Configuración	Variables de entorno y opciones de configuración	DevOps, Administradores
Seguridad	Autenticación, autorización, DLP y PII	Security Engineers
Despliegue	Docker, Kubernetes, producción	DevOps, SRE
Desarrollo	Tests, contribución, arquitectura interna	Desarrolladores

Recursos Adicionales

Documento	Descripción
Troubleshooting	Solución de problemas comunes
ADR (Architecture Decision Records)	Decisiones de arquitectura documentadas
Roadmap	Features planificadas para v1.0.0
CHANGELOG	Historial de cambios por versión
CONTRIBUTING	Guía de contribución

---

¿Qué es Cortex?

Cortex Knowledge Assistant es un sistema Retrieval-Augmented Generation (RAG) de nivel empresarial diseñado para:

• Búsqueda semántica sobre documentación corporativa
• Generación de respuestas contextualizadas con LLM
• Protección automática de información sensible (PII/DLP)
• Multi-tenancy con control de acceso basado en roles
• Integración transaccional para consultas sobre datos de clientes

Casos de Uso

• Banca: Asistente para consultas sobre productos, movimientos y normativas
• Educación: Sistema de ayuda para estudiantes con acceso a material académico
• Corporativo: Base de conocimiento interna con acceso controlado

---

Stack Tecnológico

Componente	Tecnología	Propósito
Backend API	FastAPI (Python 3.12)	API REST con streaming SSE
Frontend	React 18 + TypeScript + Vite	Interfaz de usuario
Vector Store	Qdrant	Búsqueda semántica
Cache	Redis	Rate limiting, sesiones
Database	PostgreSQL 16	Usuarios, transacciones, auditoría
LLM	HuggingFace Inference API	Generación de respuestas
Embeddings	sentence-transformers	Vectorización de documentos

---

Inicio Rápido

# 1. Clonar el repositorio
git clone https://github.com/DeepRatAI/cortex-knowledge-assistant.git
cd cortex-knowledge-assistant

# 2. Configurar variables de entorno
cp .env.example .env
# Editar .env con tu API key de HuggingFace

# 3. Iniciar con Docker Compose
docker compose up -d

# 4. Acceder a la UI
open http://localhost:3000

Para una guía detallada, ver Inicio Rápido.

---

Navegación por Perfil

Para Usuarios del Sistema

1. Guías de Usuario - Cómo usar Cortex según tu rol
2. Troubleshooting - Solución de problemas comunes

Para Desarrolladores

1. Inicio Rápido - Configurar entorno de desarrollo
2. Arquitectura - Entender el diseño del sistema
3. API Reference - Endpoints disponibles
4. Desarrollo - Tests, linting, contribución

Para DevOps / SRE

1. Configuración - Variables de entorno
2. Despliegue - Docker, Kubernetes, producción
3. Seguridad - Headers, rate limiting, compliance
4. Troubleshooting - Diagnóstico de problemas

Para Arquitectos

1. Arquitectura - Diseño hexagonal, componentes
2. ADR - Decisiones de arquitectura documentadas
3. Seguridad - Modelo de seguridad
4. Roadmap - Evolución planificada

---

Enlaces Útiles

• Demo en Vivo: cortex.deeprat.tech
• Repositorio: GitHub
• Reportar Issues: GitHub Issues

---

Licencia

Cortex Knowledge Assistant está disponible bajo licencia dual:

• AGPL-3.0 para uso open source
• Licencia comercial para uso empresarial privado

Contacto: deeprat.tec@gmail.com

---

_{Documentación para Cortex Beta}

This site is open source. Improve this page.