Este endpoint acelera a criação de formulários e contratos de extração quando você ainda não tem schema pronto.

Endpoint

POST /api/externalAPIs/public/docAnalyzer/buildInstructionFromNatural

Parâmetros

instruction
string
required

Instrução em linguagem natural descrevendo os dados desejados.

email
string

E-mail para validações adicionais quando aplicável.

dialogue
string | array

Texto ou mensagens de apoio para contextualizar o pedido.

contextData
string

Contexto adicional para melhorar a geração de schema e instruções.

Exemplo

curl -X POST "{{BASE_URL}}/api/externalAPIs/public/docAnalyzer/buildInstructionFromNatural" \
  -H "Authorization: Bearer {{TOKEN}}" \
  -H "Content-Type: application/json" \
  -d '{
    "instruction": "Quero capturar nome completo, email corporativo e se aceita newsletter."
  }'

Resposta

{
  "jsonSchema": {
    "type": "object",
    "properties": {}
  },
  "generalInstructions": "Extraia os dados solicitados mantendo formato consistente.",
  "fallbackInstructions": "",
  "targetEmail": null,
  "rawCapture": {}
}

Campos da Resposta

jsonSchema
object

Schema JSON sugerido para análise estruturada.

generalInstructions
string

Instruções principais para orientar a extração.

fallbackInstructions
string

Instruções de fallback para casos ambíguos.

targetEmail
string | null

E-mail validado quando o fluxo identificar um destinatário válido.

rawCapture
object

Estrutura intermediária com detalhes da interpretação.

Erros

CódigoDescrição
400instruction ausente ou payload inválido
401Token inválido ou ausente
500Erro interno na geração do schema e instruções