Extrair dados estruturados

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

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 fatura",
    "description": "Extrair campos do cabeçalho da fatura de faturas 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" }
  }'

import { SDK } from '@meetkai/mka1';

const mka1 = new SDK({ bearerAuth: 'Bearer <mka1-api-key>' });

const schema = await mka1.llm.extract.createSchema({
  xOnBehalfOf: '<end-user-id>', // optional — attribute the request to one of your end users
  extractionSchema: {
    name: 'Extração de fatura',
    description: 'Extrair campos do cabeçalho da fatura de faturas 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',
    },
  },
});

console.log(schema.data.id); // e.g. "schema_invoice_123"

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;

var sdk = new SDK(
    bearerAuth: $"Bearer {YOUR_API_KEY}",
    serverUrl: "https://apigw.mka1.com"
);

// The Extract API is available at sdk.Llm.Extract
// Use sdk.Llm.Extract.CreateSchema(...) to save a reusable schema
// Refer to the API reference for the full method signature and types

from meetkai_mka1 import SDK

sdk = SDK(bearer_auth="Bearer YOUR_API_KEY")

schema = sdk.llm.extract.create_schema(
    name="Extração de fatura",
    description="Extrair campos do cabeçalho da fatura de faturas 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"],
    },
)

print(schema.data.id)  # e.g. "schema_invoice_123"

curl https://apigw.mka1.com/api/v1/llm/extract/schema \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <mka1-api-key>' \
  --header 'X-On-Behalf-Of: <end-user-id>' \
  --data '{
    "name": "Extração de fatura",
    "description": "Extrair campos do cabeçalho da fatura de faturas 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 oferece suporte a multipart/form-data para essa solicitação.

mka1 llm extract extract-with-schema \
  --schema-id schema_invoice_123 \
  --model meetkai:functionary-pt \
  --prompt 'Extraia os campos estruturados da fatura.' \
  --file ./invoice.pdf

const file = Bun.file('./invoice.pdf');

const result = await mka1.llm.extract.extractWithSchema({
  schemaId: 'schema_invoice_123',
  xOnBehalfOf: '<end-user-id>',
  requestBody: {
    model: 'meetkai:functionary-pt',
    prompt: 'Extraia os campos estruturados da fatura.',
    file,
  },
});

console.log(result.data);

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Requests;

var sdk = new SDK(bearerAuth: "Bearer YOUR_API_KEY");

var fileContent = await File.ReadAllBytesAsync("./invoice.pdf");

var result = await sdk.Llm.Extract.ExtractWithSchemaAsync(
    "schema_invoice_123",
    new ExtractWithSchemaRequestBody()
    {
        Model = "meetkai:functionary-pt",
        Prompt = "Extraia os campos estruturados da fatura.",
        File = new ExtractWithSchemaFile()
        {
            FileName = "invoice.pdf",
            Content = fileContent,
        },
    }
);

Console.WriteLine(result.ExtractionResponse?.Data);

result = sdk.llm.extract.extract_with_schema(
    schema_id="schema_invoice_123",
    model="meetkai:functionary-pt",
    file={
        "file_name": "invoice.pdf",
        "content": open("./invoice.pdf", "rb"),
    },
)

print(result.data)

curl https://apigw.mka1.com/api/v1/llm/extract/schema/schema_invoice_123 \
  --request POST \
  --header 'Authorization: Bearer <mka1-api-key>' \
  --header 'X-On-Behalf-Of: <end-user-id>' \
  --form 'model=meetkai:functionary-pt' \
  --form 'prompt=Extraia os campos estruturados da fatura.' \
  --form '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

Usar um esquema em linha para trabalhos pontuais

Se não precisar reutilizar o esquema, chame POST /api/v1/llm/extract. Forneça seu JSON Schema em linha junto com os campos da solicitação de extração. Observação: este endpoint usa multipart/form-data. Em multipart/form-data, schema (e metadata, se fornecido) pode ser enviado como objetos JSON ou como strings JSON.

mka1 llm extract extract \
  --model meetkai:functionary-pt \
  --prompt 'Extraia o número e o total da fatura.' \
  --schema '{
    "type": "object",
    "properties": {
      "invoice_number": { "type": "string" },
      "total_amount": { "type": "number" }
    },
    "required": ["invoice_number", "total_amount"]
  }' \
  --file ./invoice.pdf

const file = Bun.file('./invoice.pdf');

const result = await mka1.llm.extract.extract({
  xOnBehalfOf: '<end-user-id>',
  requestBody: {
    model: 'meetkai:functionary-pt',
    prompt: 'Extraia o número e o total da fatura.',
    schema: {
      type: 'object',
      properties: {
        invoice_number: { type: 'string' },
        total_amount: { type: 'number' },
      },
      required: ['invoice_number', 'total_amount'],
    },
    // metadata: { source: 'invoices' },
    file,
  },
});

console.log(result.data);

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Requests;

var sdk = new SDK(bearerAuth: "Bearer YOUR_API_KEY");

var fileContent = await File.ReadAllBytesAsync("./invoice.pdf");

var result = await sdk.Llm.Extract.ExtractAsync(new ExtractRequestBody()
{
    Model = "meetkai:functionary-pt",
    Prompt = "Extraia o número e o total da fatura.",
    Schema = new Dictionary<string, object>()
    {
        { "type", "object" },
        { "properties", new Dictionary<string, object>()
            {
                { "invoice_number", new Dictionary<string, object>() { { "type", "string" } } },
                { "total_amount", new Dictionary<string, object>() { { "type", "number" } } },
            }
        },
        { "required", new List<object>() { "invoice_number", "total_amount" } },
    },
    // Metadata = new Dictionary<string, object>()
    // {
    //     { "source", "invoices" },
    // },
    File = new ExtractFile()
    {
        FileName = "invoice.pdf",
        Content = fileContent,
    },
});

Console.WriteLine(result.ExtractionResponse?.Data);

result = sdk.llm.extract.extract(
    model="meetkai:functionary-pt",
    schema={
        "type": "object",
        "properties": {
            "invoice_number": {"type": "string"},
            "total_amount": {"type": "number"},
        },
        "required": ["invoice_number", "total_amount"],
    },
    # metadata={"source": "invoices"},
    file={
        "file_name": "invoice.pdf",
        "content": open("./invoice.pdf", "rb"),
    },
)

print(result.data)

curl https://apigw.mka1.com/api/v1/llm/extract \
  --request POST \
  --header 'Authorization: Bearer <mka1-api-key>' \
  --header 'X-On-Behalf-Of: <end-user-id>' \
  --form 'model=meetkai:functionary-pt' \
  --form 'prompt=Extraia o número e o total da fatura.' \
  --form 'schema={"type":"object","properties":{"invoice_number":{"type":"string"},"total_amount":{"type":"number"}},"required":["invoice_number","total_amount"]}' \
  --form 'file=@./invoice.pdf'

Use o fluxo de esquema reutilizável quando quiser um contrato estável para vários arquivos.

Gerenciar esquemas salvos

O recurso Extract também permite:

Obter um esquema salvo por 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.

⌘I

Primeiros passos

Respostas

Recursos

Computação

CLI

Receitas

Benchmarks

Infraestrutura

Extrair dados estruturados

Criar um esquema reutilizável

Extrair com o esquema salvo

Usar um esquema em linha para trabalhos pontuais

Gerenciar esquemas salvos

​Criar um esquema reutilizável

​Extrair com o esquema salvo

​Usar um esquema em linha para trabalhos pontuais

​Gerenciar esquemas salvos

Criar um esquema reutilizável

Extrair com o esquema salvo

Usar um esquema em linha para trabalhos pontuais

Gerenciar esquemas salvos