OpenQCoreAI
Comenzar

Recursos · API de Knowledge

Documentación de la API de Knowledge

Referencia completa para la ingestión y recuperación de conocimiento del espacio de trabajo, los flujos de trabajo de consultas y las restricciones seguras para producción.

Volver a la documentaciónIr a los endpoints

Endpoints

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

Encabezados requeridos

Authorization: Bearer [token] o autenticación mediante clave de APIX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (o multipart/form-data para carga)

Ejemplo de carga

bash
curl -X POST "/api/v1/console/knowledge/upload" \
  -H "Authorization: Bearer [token]" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -F "file=@handbook.pdf" \
  -F "title=Team Handbook" \
  -F "tags=hr,policy"

Ejemplo de consulta

json
{
  "question": "What is our remote-work policy?",
  "top_k": 5,
  "filters": {
    "tags": ["hr", "policy"]
  },
  "session_id": "sess_123"
}

Ejemplo de respuesta

json
{
  "success": true,
  "answer": "Employees may work remotely up to 3 days per week...",
  "citations": [
    {
      "item_id": "kb_456",
      "title": "Team Handbook",
      "score": 0.91
    }
  ],
  "usage": {
    "input_tokens": 180,
    "output_tokens": 72
  },
  "metadata": {
    "retrieved_items": 5
  }
}

Restricciones de conocimiento

  • Tamaño máximo de archivo: 20MB por carga.
  • Formatos compatibles: PDF, DOC, DOCX, TXT, Markdown.
  • La ingestión se ejecuta de forma asíncrona en procesos en segundo plano.
  • El ámbito 'workspace' es obligatorio para las operaciones de knowledge en la consola.

Ciclo de vida de ingestión

  1. pending: archivo aceptado y en cola.
  2. processing: extracción/chunking/embedding en progreso.
  3. processed: el elemento está indexado y listo para consultas.
  4. failed: la ingestión falló con metadatos de diagnóstico.

Modelos de error

400

Carga útil inválida o filtros malformados.

401

Autenticación faltante o inválida.

403

Acceso al espacio de trabajo denegado por rol/alcance.

404

Elemento de conocimiento no encontrado.

413

El archivo subido excede el tamaño permitido.

415

Tipo de contenido de archivo no compatible.

422

Fallo de validación en el esquema/contexto de la solicitud.

429

Límite de solicitudes excedido.