> ## 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. # Extraer datos utilizando plantilla de esquema guardada > Extrae datos estructurados de archivos utilizando una plantilla de esquema de extracción guardada previamente. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json?language=es post /api/v1/llm/extract/schema/{schema_id} openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- La API MKA1 es una API RESTful que proporciona acceso a la plataforma MKA1. Aprende cómo comenzar con la API y el SDK de TypeScript [aquí](https://mka1.apidocumentation.com/guides/getting-started). license: name: Propietario servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Gestiona permisos para recursos LLM. Crea recursos, otorga/revoca permisos y elimina recursos. Solo los propietarios de recursos pueden otorgar, revocar o eliminar permisos. x-displayName: Autorización de Recursos - name: Embeddings description: >- Puntos finales de la API de incrustación de texto para generar representaciones vectoriales del texto. Crea incrustaciones semánticas para búsqueda, agrupamiento y coincidencia de similitudes utilizando varios modelos de incrustación. x-displayName: Incrustaciones - name: Feedback description: >- API de retroalimentación del usuario para calificar y comentar sobre las completaciones de chat. Recopila calificaciones de pulgares arriba/abajo y comentarios detallados para mejorar las respuestas del modelo y rastrear la satisfacción del usuario. x-displayName: Retroalimentación - name: Images description: >- Puntos finales de la API de generación de imágenes para crear imágenes a partir de descripciones de texto. Genera imágenes con control sobre el tamaño, la calidad y el estilo. x-displayName: Imágenes - name: MCP Vault description: >- API de bóveda MCP para almacenar configuraciones de servidor MCP propiedad del usuario y credenciales encriptadas. Los agentes hacen referencia a los ID de la bóveda para que los secretos se resuelvan solo en el momento de la ejecución de la herramienta. x-displayName: Bóveda MCP - name: Speech description: >- Puntos finales de la API de voz para el procesamiento de audio. Convierte texto en habla natural (TTS) o transcribe el habla a texto (STT) en diferentes idiomas. x-displayName: Discurso - name: Usage description: >- API de seguimiento de uso y análisis para monitorear el consumo de tokens, la cantidad de solicitudes y el análisis de costos. Visualiza estadísticas detalladas por usuario, modelo y período de tiempo. x-displayName: Uso - name: Extract description: >- API de extracción de datos estructurados para extraer información de archivos. Define esquemas JSON para extraer datos estructurados de imágenes, PDFs y documentos. Soporta plantillas de esquemas reutilizables. x-displayName: Extracción - name: Text Classification description: >- API de clasificación de texto para categorizar texto en etiquetas predefinidas. Utilice modelos de IA para clasificar el contenido del texto para análisis de sentimientos, categorización de temas y moderación de contenido. x-displayName: Clasificación de Texto - name: Responses description: >- API de respuestas impulsadas por agentes para crear agentes de IA con uso autónomo de herramientas. Crea asistentes conversacionales que pueden utilizar búsqueda en la web, operaciones con archivos, generación de imágenes, ejecución de código, simulación de uso de computadoras e integraciones de MCP. Soporta procesamiento en segundo plano, transmisión y seguimiento de estado en tiempo real. x-displayName: Respuestas - name: Files description: >- API de gestión de archivos para cargar, almacenar y gestionar archivos con expiración automática e integración con S3. Carga archivos que se pueden usar con Asistentes, Almacenes Vectoriales y otras funciones. Los archivos se almacenan en S3 con metadatos rastreados en PostgreSQL. Soporta la limpieza automática de archivos expirados. x-displayName: Archivos - name: Vector Stores description: >- API de almacenamiento de vectores para almacenar y buscar documentos utilizando incrustaciones. Crea almacenes de vectores, sube archivos con fragmentación automática y generación de incrustaciones, y realiza búsquedas semánticas. Los archivos se procesan de forma asincrónica utilizando flujos de trabajo de Temporal para durabilidad. Soporta limpieza automática de almacenes caducados y LanceDB para almacenamiento eficiente de vectores. x-displayName: Almacenes de Vectores - name: Conversations description: >- API de gestión de conversaciones para almacenar y recuperar el estado de la conversación a través de llamadas a la API de respuesta. Crea conversaciones, añade elementos (mensajes de usuario, mensajes del asistente, mensajes del sistema) y mantiene el historial de la conversación. Soporta seguimiento de metadatos y gestión del estado del diálogo en múltiples turnos. x-displayName: Conversaciones - name: Guardrails description: >- API de salvaguardias de seguridad de IA para configurar la moderación de contenido y las políticas de seguridad. Configura listas de palabras prohibidas, detección de inyección de mensajes y prevención de filtración de mensajes del sistema. Las salvaguardias se aplican a todas las solicitudes de una cuenta y se pueden probar antes del despliegue. x-displayName: Barandillas - name: Models description: >- API de listado de modelos para descubrir modelos disponibles. Devuelve IDs de modelos, propiedad y metadatos para todos los modelos registrados en la puerta de enlace. x-displayName: Modelos - name: Skills description: >- API de habilidades para gestionar paquetes de instrucciones y archivos versionados siguiendo el estándar de Habilidades del Agente. Crea, versiona y descarga paquetes de habilidades reutilizables que incluyen manifiestos SKILL.md para entornos de agentes. x-displayName: Habilidades - name: Chat Completions description: >- **Obsoleto: Usa la API de Respuestas (`/api/v1/llm/responses`) en su lugar.** Puntos finales de completación de chat con soporte para transmisión, llamadas a herramientas y múltiples proveedores. x-deprecated: true x-displayName: Completaciones de Chat - name: Batches x-displayName: Lotes - name: Evals x-displayName: Evaluaciones - name: Fine-Tuning x-displayName: Ajuste fino - name: Memory Stores x-displayName: Almacenes de memoria - name: Prompts x-displayName: Sugerencias - name: API Key x-displayName: Clave de API - name: Organization x-displayName: Organización - name: Cluster Admin x-displayName: Administrador de clúster - name: Sessions description: Crear, inspeccionar, acceder y terminar sesiones de sandbox. x-displayName: Sesiones - name: Browser description: >- Conéctate a las sesiones del navegador a través del proxy del puerto de la puerta de enlace. Las sesiones del navegador exponen un punto final del Protocolo de DevTools de Chrome en el puerto 9222. x-displayName: Navegador - name: Execution description: >- Ejecutar comandos de shell y código dentro de una sesión de sandbox existente. x-displayName: Ejecución - name: Workspace description: >- Inspeccionar el manifiesto del espacio de trabajo, transferir archivos o archivos comprimidos, y descargar artefactos generados. x-displayName: Espacio de trabajo - name: Sandbox Usage description: >- Agrega estadísticas de uso de sandbox entre sesiones, ejecución y operaciones del espacio de trabajo. x-displayName: Uso de Sandbox - name: Sandbox Pricing description: >- Gestión de administrador de clúster de la tarjeta de tarifas de cómputo del entorno aislado utilizada para el gasto presupuestado. x-displayName: Precios de Sandbox - name: Agents description: Crea y gestiona definiciones de agentes reutilizables. x-displayName: Agentes - name: Agent Versions description: >- Inspeccionar el historial de configuración de un agente y revertir a una versión anterior. x-displayName: Versiones de Agente - name: Agent Runs description: >- Ejecutar agentes guardados e inspeccionar los resultados de ejecución persistidos. x-displayName: Ejecuta Agentes - name: Agent Connectors description: >- Conecta agentes guardados a canales de mensajería externos como Telegram, incluyendo intercambio de texto, fotos y documentos compatibles. x-displayName: Conectores de agentes - name: Agent Schedules description: >- Crea y gestiona ejecuciones de agentes programadas o recurrentes guardadas. x-displayName: Horarios de Agentes - name: schema-4_other x-displayName: otro - name: Budgets x-displayName: Presupuestos - name: Settings x-displayName: Configuración - name: Compute Jobs x-displayName: Trabajos de computación - name: Compute Services x-displayName: Servicios de computación - name: Compute Catalog x-displayName: Catálogo de cómputo - name: Compute Secrets x-displayName: Calcular secretos - name: Compute Usage x-displayName: Uso de cómputo - name: Compute Tenants x-displayName: Calcular inquilinos - description: Crear, listar, leer, actualizar y eliminar repositorios. name: Repositories x-displayName: Repositorios paths: /api/v1/llm/extract/schema/{schema_id}: post: tags: - Extract summary: Extraer datos utilizando plantilla de esquema guardada description: >- Extrae datos estructurados de archivos utilizando una plantilla de esquema de extracción guardada previamente. operationId: extractWithSchema parameters: - name: schema_id in: path required: true schema: type: string description: >- El identificador único del esquema de extracción que se utilizará para esta extracción. example: schema_invoice_123 - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. requestBody: required: true content: multipart/form-data: example: model: meetkai:functionary-urdu-mini-pak prompt: Extract the structured invoice fields. file: (binary) schema: type: object properties: model: type: string description: ID del modelo a utilizar para la extracción file: type: string format: binary description: El archivo del que extraer datos estructurados prompt: type: string description: >- Indicaciones personalizadas opcionales del sistema para guiar la extracción required: - model - file responses: '200': description: Está bien content: application/json: schema: $ref: '#/components/schemas/ExtractionResponse' example: success: true data: invoice_number: INV-2024-001 vendor_name: Acme Corporation total_amount: 1250 date: '2024-01-15' metadata: model: meetkai:functionary-urdu-mini-pak filename: invoice.pdf fileSize: 125000 extractedAt: '2024-01-15T10:30:00Z' schemaId: schema_invoice_123 schemaName: Invoice Extraction security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.extract.extract_with_schema(schema_id="schema_invoice_123", model="meetkai:functionary-urdu-mini-pak", file={ "file_name": "example.file", "content": open("example.file", "rb"), }, prompt="Extract the structured invoice fields.") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; import { openAsBlob } from "node:fs"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.extract.extractWithSchema({ schemaId: "schema_invoice_123", requestBody: { model: "meetkai:functionary-urdu-mini-pak", file: await openAsBlob("example.file"), prompt: "Extract the structured invoice fields.", }, }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: |- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; using MeetKai.MKA1.Types.Requests; var sdk = new SDK(bearerAuth: ""); var res = await sdk.Llm.Extract.ExtractWithSchemaAsync( schemaId: "schema_invoice_123", body: new ExtractWithSchemaRequestBody() { Model = "meetkai:functionary-urdu-mini-pak", File = new ExtractWithSchemaFile() { FileName = "example.file", Content = System.IO.File.ReadAllBytes("example.file"), }, Prompt = "Extract the structured invoice fields.", } ); // handle response components: schemas: ExtractionResponse: type: object properties: success: type: boolean description: Indica si la solicitud de extracción fue exitosa. data: description: >- Los datos estructurados extraídos que cumplen con el esquema JSON proporcionado. Este es el resultado de analizar el archivo y extraer información de acuerdo con la definición del esquema. metadata: type: object properties: model: type: string description: El modelo que se utilizó para realizar la extracción filename: type: string description: El nombre del archivo que fue procesado fileSize: type: number description: El tamaño del archivo procesado en bytes extractedAt: type: string description: >- Marca de tiempo ISO 8601 que indica cuándo se realizó la extracción. schemaId: type: string description: >- El ID del esquema de extracción que se utilizó (solo presente al usar un esquema guardado) schemaName: type: string description: >- El nombre del esquema de extracción que se utilizó (presente solo al usar un esquema guardado) required: - model - filename - fileSize - extractedAt description: Metadatos sobre la solicitud de extracción y la ejecución required: - success - metadata description: >- Respuesta del punto final de extracción que contiene los datos estructurados extraídos y los metadatos sobre el proceso de extracción. examples: - success: true data: invoice_number: INV-2024-001 vendor_name: Acme Corporation total_amount: 1250 date: '2024-01-15' metadata: model: meetkai:functionary-urdu-mini-pak filename: invoice.pdf fileSize: 125000 extractedAt: '2024-01-15T10:30:00Z' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Gateway auth: send `Authorization: Bearer `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ````