OpenQCoreAI
Comenzar

Recursos · Documentación

Documentación de la plataforma.

Listo para producción por diseño.

Documentación de OpenQCore para equipos que crean productos de IA fiables en chat, voz, generación multimodal y flujos de trabajo de conocimiento, con control de tiempo de ejecución acotado.

Comienza a construirSuperficie de API
Tiempo de ejecución orientado a APIAlcances de espacio de trabajo y personalesStreaming + No streamingLímite de tasa + deduplicación + bloqueoCanal de voz (STT/LLM/TTS)APIs de conocimiento de la consola

Inicio rápido

Desde la primera solicitud hasta el entorno de producción en cuestión de minutos.

1) Autenticar

Usa autenticación de sesión JWT o autenticación por clave API con control de acceso basado en el ámbito.

2) Elegir ámbito de ejecución

Establece el contexto personal o del espacio de trabajo usando las cabeceras de runtime cuando sea necesario.

3) Llamar a chat completions

Usa /api/v1/chat/completions para la ejecución principal del asistente.

4) Agregar voz y multimodal

Usa los endpoints /api/v1/voice e Iris para flujos de trabajo de STT/TTS, imagen, video y OCR.

5) Integrar conocimiento

Usa /api/v1/console/knowledge para carga, ingestión y consultas basadas en recuperación.

URL base

Base pública de la API

/api/v1

Todos los endpoints públicos de la plataforma están montados bajo /api/v1.

Autenticación y ámbito

Acceso contextual para ejecuciones personales y en espacios de trabajo.

Métodos de autenticación

JWT/sesión o clave API

Cabecera de ámbito

X-Scope-Type: personal | workspace

Cabecera de espacio de trabajo

X-Workspace-ID: [uuid] (requerido en el ámbito del espacio de trabajo)

Cabecera de agente

X-Agent-ID: [uuid] (opcional)

Reglas de validación

  • Si scope es personal, workspace_id no está permitido.
  • Si scope es workspace, workspace_id es obligatorio.
  • Los encabezados de scope inválidos devuelven 422.

Límites de tasa

Limitación basada en políticas según el contexto de autenticación.

Clave API

60 solicitudes / minuto

La clave del bucket utiliza el hash de la clave API como identidad.

JWT/sesión

120 solicitudes / minuto

La clave del bucket utiliza el ID del workspace cuando está presente; de lo contrario, el ID del usuario.

Encabezados de respuesta de limitación

Retry-AfterX-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset

Tiempo de ejecución del chat

/chat/completions con capas de control en producción.

GET /api/v1/chat/health
POST /api/v1/chat/completions

Comportamientos de ejecución

  • Seguimiento de backpressure y rechazo por sobrecarga del sistema (503).
  • Bloqueo distribuido para prevenir procesamiento duplicado en curso (409).
  • Caché de deduplicación para respuestas no en streaming.
  • Persistencia de sesión/mensajes para los turnos de usuario y asistente.
  • Validación en tiempo de ejecución para la solicitud, los adjuntos y el acceso a la sesión.

Tiempo de ejecución de voz

Canalización STT → LLM → TTS con streaming e interrupción.

POST /api/v1/voice/chat/meta
POST /api/v1/voice/chat
POST /api/v1/voice/interrupt/{session_id}
WS /api/v1/voice/ws

Características de voz

  • Enrutador de proveedor de respaldo (OpenAI + Azure).
  • Interruptores de circuito para las fases STT, LLM y TTS.
  • Canalización de conversión de audio para entradas que no son WAV.
  • Respuestas de audio en streaming con encabezados de metadatos.
  • Contexto de cancelación para interrupciones a nivel de sesión.
  • Reducción de carga y degradación de calidad bajo alta carga.

Iris Multimodal

Flujos de trabajo de imagen, vídeo, OCR y verificación enrutados por modelo.

Catálogo de modelos

iris-orbit

Modo de enrutamiento automático

iris-genesis

Generación de imágenes

iris-edit

Edición de imágenes (no implementada)

iris-lens

Análisis de imágenes (no implementado)

iris-video

Generación de vídeo

iris-ocr

OCR de documentos

iris-verify

Verificación de identidad

iris-guard

Detección de fraude (no implementada)

iris-face

Verificación facial (no implementada)

Conocimiento de la consola

APIs de conocimiento de la consola del espacio de trabajo para ingestión y consultas.

/api/v1/console/knowledge
GET /api/v1/console/knowledge
POST /api/v1/console/knowledge
POST /api/v1/console/knowledge/upload
GET /api/v1/console/knowledge/{item_id}
PATCH /api/v1/console/knowledge/{item_id}
DELETE /api/v1/console/knowledge/{item_id}
POST /api/v1/console/knowledge/ask

Restricciones de conocimiento

  • Tamaño máximo de archivo: 20MB
  • Tipos permitidos: PDF, DOC, DOCX, TXT, Markdown
  • La ingestión se ejecuta de forma asíncrona en segundo plano
  • Estados: pendiente → procesando → procesado | fallido

Semántica de errores

Clases de respuesta comunes de la plataforma.

400

Solicitud inválida, datos faltantes o entrada malformada

401

Autenticación ausente o inválida

403

Alcance no permitido / restricción por rol del espacio de trabajo

404

Recurso no encontrado

409

Solicitud ya en procesamiento (conflicto de bloqueo)

413

Carga útil demasiado grande (p. ej., límites de audio/archivo)

415

Tipo de contenido no compatible

422

Fallo de validación (alcance/contexto/esquema)

429

Límite de tasa excedido

503

Sobrecarga del sistema / proveedor no disponible

Observabilidad

Ejecución rastreable a lo largo de los ciclos de vida de chat y voz.

  • IDs de traza para la correlación de solicitudes.
  • Canalización de middleware para registro de uso.
  • Inicialización de OpenTelemetry con exportación OTLP.
  • Los encabezados de respuesta exponen señales de temporización en los flujos de voz.
X-Trace-IDX-Session-IDX-STT-Time-MSX-LLM-Time-MSX-TTS-Time-MS

Navegación de la documentación

Explora las secciones de la documentación

Salta directamente a guías de implementación y referencias de producción para cada superficie de ejecución.

Autenticación

Autenticación con JWT/clave API, encabezados de alcance y modelo de validación.

API de Chat

Completions, comportamiento de streaming y controles en tiempo de ejecución.

API de Voz

Canalización de voz en tiempo real, flujo de interrupción y encabezados de metadatos.

API de Iris

Puntos finales y enrutamiento para imagen/video/OCR/verificación.

API de Conocimiento

Carga, ciclo de vida de indexación, recuperación y flujos de trabajo de consulta.

Proveedores

Matriz de capacidades, política de enrutamiento y estrategia de conmutación por error.

Contratos de salida

Formato de respuesta unificado entre proveedores y modalidades.

Arquitectura

Capas de tiempo de ejecución, abstracción de proveedores y garantías del sistema.

Construya con confianza en el runtime de OpenQCore.

Utilice la documentación como su mapa de producción para chat, voz, generación multimodal y ejecución respaldada por conocimiento.

Abrir Explorador de APIIr a Infraestructura