Saltar al contenido principal
POST
/
api
/
v1
/
llm
/
extract
/
schema
Python (SDK)
from openapi import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.extract.create_schema(name="Invoice Extraction", 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",
        ],
    }, description="Schema for extracting invoice data from PDF documents", metadata={
        "document_type": "invoice",
    })

    # Handle response
    print(res)
{
  "success": true,
  "data": {
    "id": "schema_invoice_123",
    "name": "Invoice Extraction",
    "description": "Schema for extracting invoice data from PDF documents",
    "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"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Autorizaciones

Authorization
string
header
requerido

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cuerpo

application/json

Definición de esquema para crear una plantilla de extracción reutilizable. Los esquemas de extracción definen la estructura y las reglas de validación para la extracción de datos de archivos.

name
string
requerido

Nombre del esquema de extracción. Debe tener entre 1 y 100 caracteres. Se utiliza para identificar y hacer referencia al esquema.

Required string length: 1 - 100
schema
object
requerido

Esquema JSON que define la estructura de los datos a extraer. Especifica los campos, tipos y reglas de validación para los datos extraídos.

description
string

Descripción opcional del esquema. Máximo 500 caracteres. Ayuda a documentar el propósito y uso del esquema.

Maximum string length: 500
metadata
object

Metadatos opcionales para el esquema. Puede almacenar información adicional como versión, autor o propiedades personalizadas.

Respuesta

200 - application/json

Está bien

Respuesta de la creación de un nuevo esquema de extracción.

success
boolean
requerido

Indica si la creación del esquema fue exitosa

data
object
requerido

El esquema de extracción creado con ID generado y marcas de tiempo.