Skip to main content

ocr.extract

Ler documento (IA)

IA lê um documento e extrai os campos para registos.

  • Kind: step
  • Key: ocr.extract
  • Categoria: source
  • Envelope: mapa (um objeto JSON em config)

Campos

ChaveTipoObrigatórioOmissãoDescriçãoReferência
schemajsonnão{}Schema da extração (os campos a tirar do documento). Vazio = extração livre: a IA devolve os campos que encontrar.-
invalidSchemastringnão""Texto cru do schema quando não é um JSON de objeto. Não-vazio = config por corrigir, e o passo falha antes de gastar uma extração paga.-
systemPromptstringnão"És um extrator de dados de documentos. Devolve apenas JSON válido com os campos pedidos no schema."Instrução de sistema enviada ao modelo. Aceita tokens {{record.x}}/{{vars.y}}.expressões {{record.coluna}}
userPromptstringnão"Extrai os campos do documento segundo o schema fornecido."Pedido concreto ao modelo, por cima da instrução de sistema. Aceita tokens {{record.x}}/{{vars.y}}.expressões {{record.coluna}}
modelSourcemapnão-De onde vem o modelo de IA: o catálogo OutDo (omissão) ou uma ligação ai_provider da organização.-
splitDocumentsbooleannãofalseO ficheiro pode trazer vários documentos (um PDF com 20 faturas): cada um sai como um registo separado.-

modelSource

ChaveTipoObrigatórioOmissãoDescriçãoReferência
kindenumerationnão"catalog"Catálogo OutDo (resolvido pelas definições de IA da organização) ou ligação própria (BYOK).-
modeenumerationnão-Slot do catálogo a forçar. Ausente = o slot por omissão do passo. Só conta no modo de catálogo.-
connectionNamestringnão-Nome da ligação ai_provider que serve o modelo. Só conta no modo de ligação.ligação (nome)

Exemplo JSON

{
"schema": {},
"invalidSchema": "",
"systemPrompt": "És um extrator de dados de documentos. Devolve apenas JSON válido com os campos pedidos no schema.",
"userPrompt": "Extrai os campos do documento segundo o schema fornecido.",
"splitDocuments": false
}

Gerado de definitions.json versão 17f3e0bc59d9. Esta página nasce no build: não se edita à mão.