Manual do IngestCore
Tudo o que o produto faz, na ordem em que você vai usar. As telas abaixo são do produto real, com dados fictícios — nenhum documento de cliente aparece aqui.
Fluxo do sistema
O IngestCore é um encanamento de documentos: entra arquivo, sai dado estruturado. O desenho abaixo é o caminho completo — cada caixa corresponde a uma tela ou rotina descrita neste manual.
Documento retido pela análise de segurança continua legível dentro do produto — o que ele não faz é sair: exportação, integração e nuvem ficam bloqueadas até a liberação com justificativa.
Instalação
Baixe o XCODEF-IngestCore-1.0.0-Setup.exe na página do produto ou na Microsoft Store e execute. A instalação:
- Não pede administrador — instala no seu perfil de usuário;
- Leva tudo dentro: API local, worker de leitura, OCR (português e inglês) e o gerenciador de IA local;
- Cria atalho no Menu Iniciar e na Área de Trabalho;
- Guarda seus dados fora da pasta do programa, em %LOCALAPPDATA%\XCODEF\IngestCore — atualizar ou reinstalar nunca leva seus documentos junto.
Requisitos: Windows 10/11 64 bits, 8 GB de RAM (16 GB recomendado para IA local), 1 GB de disco para o produto mais espaço para seus documentos. Placa de vídeo é opcional — com ela, a IA local fica mais rápida e o próprio produto recomenda modelos melhores.
Primeiro uso
Na primeira abertura, um assistente de nove passos configura o essencial em cerca de dois minutos: pasta de entrada, idioma do OCR, IA local (opcional) e um resumo do que fica ativo de segurança. “Agora não” é resposta válida em qualquer etapa — tudo pode ser configurado depois, e o assistente não volta a aparecer sozinho.
- Bem-vindo e preparação — onde os dados ficam;
- Verificação de componentes — banco, OCR e área de dados conferidos na hora;
- Pasta de entrada — escolha uma pasta sua (ex.: Documentos\IngestCore\Entrada). O assistente recusa pastas internas do produto;
- OCR — idioma principal dos documentos;
- IA local — “Analisar este computador” mede processador, memória e placa de vídeo e recomenda o modelo certo, com tamanho de download visível antes de qualquer clique;
- Nuvem (opcional) — desligada por padrão; exige três decisões suas para existir;
- Segurança — resumo do que está ativo;
- Concluir — o produto já está trabalhando.
Cockpit gerencial
A tela que responde o que o dono da operação pergunta: quantos documentos entraram, quantos passaram sem toque humano, qual a confiança média, onde o tempo está sendo gasto e o que precisa de atenção hoje.
Os indicadores recortam por hoje, 7 dias, 30 dias ou todo o período. Clicar num tipo documental filtra o cockpit inteiro por ele — é assim que se descobre que o atraso está só nas DANFEs de um fornecedor.
Pasta vigiada e importação
A pasta vigiada é o coração da operação: todo arquivo que cai nela é importado automaticamente (XML, PDF, JPG, PNG). Depois de lido, o original é movido para a subpasta lidos\<TIPO> — organizado por tipo documental — e o que falhar vai para _erro com o motivo num arquivo ao lado.
Também dá para importar manualmente pelo botão Importar e reprocessar qualquer documento sem contar de novo na licença.
Operação e conferência
A tela Operação é a mesa de trabalho: fila de processamento, documentos aguardando conferência e o detalhe completo de cada um — dados extraídos, texto lido, resultados por etapa e auditoria.
Documentos com confiança abaixo da régua do tipo entram em conferência: você vê o documento e os campos lado a lado, corrige o que precisar e aprova. A régua é configurável por tipo documental — nota de fornecedor pode exigir 95%, recibo interno pode aceitar 80%.
As abas do documento mostram cada etapa separadamente, o que torna fácil descobrir onde algo deu errado: se o texto do OCR está bom mas o campo saiu vazio, o problema é de extração, não de leitura.
Tipos documentais
Cada tipo (DANFE, NFS-e, boleto, recibo, contrato…) tem seu fluxo: palavras-chave de classificação, prompt de extração, esquema de validação, régua de conferência e nível de sigilo. Os 19 tipos de fábrica cobrem o dia a dia fiscal — e novos tipos são dados, não código: sua instalação pode ganhar um tipo específico da sua operação sem atualizar o produto (serviço XCODEF, R$ 150/h).
IA local
A aba IA local na Central de IA é o gerenciador inteligente: ele mede o seu computador (processador, memória, placa de vídeo, espaço) e recomenda a melhor configuração — você não precisa saber o que é VRAM ou quantização.
- Instalação assistida do mecanismo (Ollama): origem oficial, integridade conferida por SHA-256, progresso real e cancelamento;
- Catálogo homologado: só modelos testados pela XCODEF, com tamanho visível antes do download;
- Teste com um clique: o modelo é aprovado na SUA máquina antes de entrar em produção;
- Sem IA também funciona: o OCR embarcado segue lendo tudo; a IA melhora a extração, não é pré-requisito.
As demais abas cobrem o ciclo completo de inteligência: testar extração numa bancada isolada, ensinar a IA a partir de correções reais, escolher provedores e modelos, e acompanhar custo quando a nuvem é usada.
Segurança e quarentena
Todo documento passa por uma análise determinística (sem IA — não há o que “convencer”) que procura conteúdo tentando manipular a leitura: instruções escondidas, texto invisível, divergência entre o que o PDF mostra e o que ele contém. Risco alto significa quarentena automática.
- Documento em quarentena não exporta, não integra e não sobe para nuvem — mas continua legível para você julgar;
- Liberação exige justificativa e fica auditada;
- Matriz de sigilo: cada tipo documental tem nível (Público / Interno / Confidencial / Restrito) e a consequência é visível — Restrito nunca sai da máquina, mesmo com nuvem configurada;
- Cada bloqueio vira evento de auditoria consultável.
Licença e ativação
O período de avaliação inclui 1.000 documentos ou 120 dias, o que vier primeiro — sem cadastro. A partir de 80% de uso, um aviso mostra a barra de consumo, o código da máquina (XCM-…) e o caminho de compra.
- Copie o código da máquina na aba Licença (um clique);
- Faça o pedido em xcodef.com/ingestcore/pedido informando o código;
- Pague por Pix, boleto ou cartão;
- A chave chega por e-mail — cole na aba Licença e clique Ativar. A ativação é offline: nada da sua máquina é enviado.
Quando a avaliação termina, a ingestão de documentos novos pausa — tudo que já foi processado continua acessível, pesquisável e exportável. Seus dados nunca ficam reféns. Trocou de computador? A XCODEF reemite a chave para o novo código.
Exportação e ERP
O resultado de cada documento é um JSON canônico — campos, itens, totais e nível de confiança num formato estável. A exportação gera JSON e CSV prontos para importar; layouts específicos do seu ERP (Protheus, Sankhya, Omie…) são construídos sob medida e passam a fazer parte da sua instalação.
Documentos em quarentena são retidos com aviso — a exportação diz quantos ficaram de fora e por quê, para a conciliação nunca fechar errado em silêncio.
Central de Parâmetros
Tudo que é configurável mora aqui, agrupado por assunto e com diagnóstico embutido: status dos componentes, automação, leitura, IA e OCR, operação, pastas, backup, segurança, sistema e licença. Perfis permitem exportar e importar a configuração inteira — útil para padronizar várias máquinas.
Guia de implantação (TI)
| Privilégios | Instalação por usuário (%LOCALAPPDATA%). Não exige administrador nem UAC no uso normal. |
| Rede | API local escuta somente em 127.0.0.1 (porta preferida 3333; se ocupada, usa outra e registra). Nenhum documento sai da máquina sem provedor de nuvem configurado + política permitindo + orçamento maior que zero. |
| Saídas de rede possíveis | Somente as que o cliente habilitar: download de modelos de IA (origem oficial) e provedor de nuvem com chave do próprio cliente. Verificável por firewall. |
| Autenticação interna | Token aleatório por sessão entre interface e API — sem segredo fixo em disco. |
| Instalação silenciosa | Setup.exe /S (NSIS). Mesmo artefato do site e da Microsoft Store. |
| Dados | %LOCALAPPDATA%\XCODEF\IngestCore (banco SQLite, logs, backups, exportações). Desinstalar preserva os dados. |
| Atualização | Instalar a versão nova por cima; migrações rodam sozinhas na primeira abertura; dados preservados. |
| Processos | Três processos: IngestCore.exe (interface), API local (Node embarcado) e worker (Python embarcado). Supervisionados pelo aplicativo; fechar a janela mantém a vigia na bandeja; Sair encerra tudo. |
| Requisitos de IA local | Opcional. 8 GB de RAM no mínimo (16 GB recomendado); placa de vídeo acelera; o produto mede e recomenda — sem placa ele escolhe modelos leves ou só OCR. |
| Logs técnicos | %LOCALAPPDATA%\XCODEF\IngestCore\logs (desktop.log, api-local.log, worker-ingestcore.log). |
Solução de problemas
- O aplicativo abre mas mostra “serviço local não iniciou”Veja %LOCALAPPDATA%\XCODEF\IngestCore\logs\desktop.log — a causa está na última linha [ERRO]. Feche pelo ícone da bandeja (Sair) e abra de novo.
- Coloquei um arquivo na pasta e nada aconteceuConfirme em Central de Parâmetros → Automação que a vigia está ativa e apontando para a pasta certa. Arquivos com falha vão para a subpasta _erro com o motivo ao lado.
- Um documento ficou em quarentenaÉ a análise de segurança fazendo o trabalho dela. Abra o documento → aba Segurança → veja os achados; se for falso positivo, libere com justificativa.
- A chave de licença não ativaConfira se copiou a chave inteira (começa com XCODEF.) e se ela foi emitida para esta máquina — a aba Licença mostra o código local. Divergiu? Responda o e-mail da chave pedindo reemissão.
- A IA local ficou lentaCentral de IA → IA local → Testar. Se o teste sugerir um modelo mais leve, aceite — ele foi escolhido para a sua máquina real.
- Preciso mudar o produto de computadorInstale no novo, copie a pasta %LOCALAPPDATA%\XCODEF\IngestCore (dados) e peça a reemissão da chave com o novo código de máquina.
Não resolveu? contato@xcodef.com — anexe o pacote de diagnóstico (Central de Parâmetros → Status → Exportar diagnóstico).