Pular para o conteúdo 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"
  }
}

Autorizações

Authorization
string
header
obrigatório

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 caminho

schema_id
string
obrigatório

O identificador único do esquema de extração a ser usado para esta extração

Corpo

multipart/form-data
model
string
obrigatório

ID do modelo a ser usado para extração

file
file
obrigatório

O arquivo para extrair dados estruturados.

prompt
string

Prompt personalizado opcional para guiar a extração

Resposta

200 - application/json

OK

Resposta do endpoint de extração contendo os dados estruturados extraídos e metadados sobre o processo de extração.

success
boolean
obrigatório

Indica se a solicitação de extração foi bem-sucedida.

metadata
object
obrigatório

Metadados sobre a solicitação e execução da extração

data
any

Os dados estruturados extraídos de acordo com o JSON Schema fornecido. Este é o resultado da análise do arquivo e da extração de informações de acordo com a definição do esquema.