Pular para o conteúdo principal

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.

Use o recurso Extract quando quiser que a API MKA1 transforme um documento ou imagem enviado em JSON estruturado. Você pode definir o esquema inline para uma solicitação pontual ou salvar um modelo de esquema reutilizável primeiro.

​
Criar um esquema reutilizável

Salve um modelo de esquema quando quiser executar o mesmo formato de extração várias vezes. 
mka1 llm extract create-schema \
  -H 'X-On-Behalf-Of: <end-user-id>' \
  --body '{
    "name": "Extração de nota fiscal",
    "description": "Extrair campos do cabeçalho de notas fiscais em PDF",
    "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" }
  }'
Isso retorna um ID de esquema como schema_invoice_123.

​
Extrair com o esquema salvo

Use o ID do esquema salvo para extrair dados de um arquivo. A especificação OpenAPI suporta multipart/form-data para esta solicitação. 
mka1 llm extract extract-with-schema \
  --schema-id schema_invoice_123 \
  --model meetkai:functionary-pt \
  --prompt 'Extraia os campos estruturados da nota fiscal.' \
  --file ./invoice.pdf
Uma resposta bem-sucedida retorna um objeto JSON com:
  • success
  • data contendo os campos extraídos
  • metadata sobre a execução da extração

​
Use um esquema inline para trabalhos pontuais

Se você não precisa reutilizar o esquema, chame POST /api/v1/llm/extract em vez disso. Forneça seu JSON Schema inline juntamente com os campos da solicitação de extração. Nota: na especificação OpenAPI, este endpoint é definido como application/json (o campo file é enviado como uma string codificada em binário). 
mka1 llm extract extract \
  --model meetkai:functionary-pt \
  --prompt 'Extraia o número da nota fiscal e o total.' \
  --schema '{
    "type": "object",
    "properties": {
      "invoice_number": { "type": "string" },
      "total_amount": { "type": "number" }
    },
    "required": ["invoice_number", "total_amount"]
  }' \
  --file ./invoice.pdf
Use o fluxo de esquema reutilizável quando quiser um contrato estável entre vários arquivos.

​
Gerenciar esquemas salvos

O recurso Extract também permite:
  • Obter um esquema salvo pelo ID.
  • Atualizar um esquema salvo.
  • Excluir um esquema salvo.
Use esses endpoints quando seu contrato de extração mudar ao longo do tempo e você precisar manter o esquema sincronizado.