Doc Analyzer - buildInstructionFromNatural
Converte instrução em linguagem natural em schema e instruções refinadas para captura estruturada
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
Instrução em linguagem natural descrevendo os dados desejados.
E-mail para validações adicionais quando aplicável.
Texto ou mensagens de apoio para contextualizar o pedido.
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
Schema JSON sugerido para análise estruturada.
Instruções principais para orientar a extração.
Instruções de fallback para casos ambíguos.
E-mail validado quando o fluxo identificar um destinatário válido.
Estrutura intermediária com detalhes da interpretação.
Erros
| Código | Descrição |
|---|---|
400 | instruction ausente ou payload inválido |
401 | Token inválido ou ausente |
500 | Erro interno na geração do schema e instruções |