Pular para o conteúdo principal
POST
/
api
/
v1
/
llm
/
extract
/
schema
Python (SDK)
from openapi import SDK


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

    res = sdk.llm.extract.create_schema(name="Invoice Extraction", 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",
        ],
    }, description="Schema for extracting invoice data from PDF documents", metadata={
        "document_type": "invoice",
    })

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

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

Corpo

application/json

Definição de esquema para criar um modelo de extração reutilizável. Esquemas de extração definem a estrutura e as regras de validação para a extração de dados de arquivos.

name
string
obrigatório

Nome do esquema de extração. Deve ter entre 1 e 100 caracteres. Usado para identificar e referenciar o esquema.

Required string length: 1 - 100
schema
object
obrigatório

Objeto JSON Schema definindo a estrutura dos dados a serem extraídos. Especifica os campos, tipos e regras de validação para os dados extraídos.

description
string

Descrição opcional do esquema. Máximo de 500 caracteres. Ajuda a documentar o propósito e o uso do esquema.

Maximum string length: 500
metadata
object

Metadados opcionais para o esquema. Pode armazenar informações adicionais como versão, autor ou propriedades personalizadas.

Resposta

200 - application/json

OK

Resposta da criação de um novo esquema de extração.

success
boolean
obrigatório

Indica se a criação do esquema foi bem-sucedida

data
object
obrigatório

O esquema de extração criado com ID gerado e carimbos de data/hora