Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

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

Utiliza el recurso Extract cuando quieras que la API de MKA1 convierta un documento o imagen subido en un JSON estructurado. Puedes definir el esquema en línea para una solicitud puntual, o guardar primero una plantilla de esquema reutilizable.

​
Crear un esquema reutilizable

Guarda una plantilla de esquema cuando quieras ejecutar el mismo formato de extracción muchas veces. 
mka1 llm extract create-schema \
  -H 'X-On-Behalf-Of: <end-user-id>' \
  --body '{
    "name": "Extracción de factura",
    "description": "Extraer los campos de cabecera de facturas PDF",
    "schema": {
      "type": "object",
      "properties": {
        "invoice_number": { "type": "string" },
        "vendor_name": { "type": "string" },
        "total_amount": { "type": "number" },
        "date": { "type": "string", "format": "date" }
      },
      "required": ["invoice_number", "total_amount"]
    },
    "metadata": { "document_type": "invoice" }
  }'
Esto devuelve un ID de esquema como schema_invoice_123.

​
Extraer con el esquema guardado

Utiliza el ID del esquema guardado para extraer datos de un archivo. La especificación OpenAPI admite multipart/form-data para esta solicitud. 
mka1 llm extract extract-with-schema \
  --schema-id schema_invoice_123 \
  --model meetkai:functionary-es-mini \
  --prompt 'Extrae los campos estructurados de la factura.' \
  --file ./invoice.pdf
Una respuesta exitosa devuelve un objeto JSON con:
  • success
  • data que contiene los campos extraídos
  • metadata sobre la ejecución de la extracción

​
Usar un esquema en línea para trabajos puntuales

Si no necesitas reutilizar el esquema, llama a POST /api/v1/llm/extract en su lugar. Proporciona tu JSON Schema en línea junto con los campos de la solicitud de extracción. Nota: en la especificación OpenAPI, este endpoint se define como application/json (el campo file se envía como una cadena codificada en binario). 
mka1 llm extract extract \
  --model meetkai:functionary-es-mini \
  --prompt 'Extrae el número de factura y el total.' \
  --schema '{
    "type": "object",
    "properties": {
      "invoice_number": { "type": "string" },
      "total_amount": { "type": "number" }
    },
    "required": ["invoice_number", "total_amount"]
  }' \
  --file ./invoice.pdf
Utiliza el flujo de esquemas reutilizables cuando quieras un contrato estable a través de muchos archivos.

​
Gestionar esquemas guardados

El recurso Extract también te permite:
  • Obtener un esquema guardado por ID.
  • Actualizar un esquema guardado.
  • Eliminar un esquema guardado.
Utiliza esos endpoints cuando tu contrato de extracción cambie con el tiempo y necesites mantener el esquema sincronizado.