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


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) 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)
{
  "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"
  }
}

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

Parámetros de ruta

schema_id
string
requerido

El identificador único del esquema de extracción que se utilizará para esta extracción.

Cuerpo

multipart/form-data
model
string
requerido

ID del modelo a utilizar para la extracción

file
file
requerido

El archivo para extraer datos estructurados de

prompt
string

Texto: Aviso opcional del sistema personalizado para guiar la extracción

Respuesta

200 - application/json

Está bien

Respuesta del punto de extracción que contiene los datos estructurados extraídos y los metadatos sobre el proceso de extracción.

success
boolean
requerido

Indica si la solicitud de extracción fue exitosa.

metadata
object
requerido

Metadatos sobre la solicitud de extracción y ejecución

data
any

Los datos estructurados extraídos que cumplen con el esquema JSON proporcionado. Este es el resultado de analizar el archivo y extraer información según la definición del esquema.