Saltar al contenido principal
PUT
/
api
/
v1
/
llm
/
extract
/
schema
/
{schema_id}
Python (SDK)
from mka1 import SDK


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

    res = sdk.llm.extract.update_schema(schema_id="schema_invoice_123", name="Invoice Extraction v2", metadata={
        "document_type": "invoice",
        "version": "2",
    })

    # Handle response
    print(res)
{
  "success": true,
  "data": {
    "id": "schema_invoice_123",
    "name": "Invoice Extraction v2",
    "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",
      "version": "2"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-02-01T10:30:00Z"
  }
}

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.

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>.

Encabezados

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Parámetros de ruta

schema_id
string
requerido

El identificador único del esquema de extracción a actualizar.

Cuerpo

application/json

Campos a actualizar en el esquema de extracción. Todos los campos son opcionales; solo se actualizarán los campos proporcionados.

name
string

Nombre nuevo opcional para el esquema de extracción

Required string length: 1 - 100
description
string

Descripción nueva opcional para el esquema

Maximum string length: 500
schema
object

Definición de esquema JSON actualizada opcional

metadata
object

Metadatos actualizados opcionales

Respuesta

200 - application/json

Está bien

Respuesta de la actualización de un esquema de extracción existente.

success
boolean
requerido

Indica si la actualización del esquema fue exitosa.

data
object
requerido

El esquema de extracción actualizado con la nueva marca de tiempo updatedAt