Analisar documento
Extrair → Analisar documento
O Analisar documento API Extrai dados estruturados de um PDF usando um modelo que você cria no PDF4me painel. Você envia docContent (opcional; se omitido, o documento é obtido por docName), docName, TemplateId (GUID) ou TemplateName, ParseId (GUID), e opcionalmente async. O API retornos JSON Com dados analisados (tipo de documento, número de páginas, campos extraídos). Use o testador abaixo para experimentar; mais detalhes estão nas seções seguintes.
Experimente a função Analisar Documento. API
:::nota Referência rápida
Ponto final: POST /api/v2/ParseDocument · Obrigatório: api-key, docName, TemplateId (ou TemplateName), ParseId
:::
Use o formulário abaixo para enviar sua API chave, PDF (Base64 ou referenciado por docName), ID ou nome do modelo e ID de análise. A resposta é JSON Com dados de documentos analisados. Nenhum código é necessário, preencha os campos e clique. Enviar solicitação.
Visão geral, parâmetros e casos de uso
- Overview
- Parameters
- Use cases
O que é Parse Document?
Este endpoint extrai dados estruturados de um PDF usando um analisar modelo você cria no PDF4me painel de controle. Você fornece o PDF (docContent Opcional; se omitido, o documento é obtido por docName), docName, TemplateId (GUID) ou TemplateName, e ParseId (GUID). O API retornos JSON com tipo de documento, número de páginas e campos extraídos com base nas áreas de captura e chaves do seu modelo.
Principais características
- Baseado em modeloCrie um modelo no painel de controle: carregue um exemplo. PDF, desenhe áreas de captura, configure chaves e expressões regulares.
- TemplateId ou TemplateNameUtilize o modelo. GUID ou nomeie a partir do painel de controle.
- ParseId: Exclusivo GUID por operação de análise (gerar no lado do cliente ou usar API-oferecido).
- Saída estruturada: JSON com tipo de documento, número de páginas e dados estruturados extraídos.
Obtendo IDs de modelo e análise
- Acesso PDF4me PainelVá para o analisar documento página.
- Criar um modeloClique em "Adicionar", insira um nome para o modelo e, em seguida, salve.
- Configurar modeloCarregar um modelo PDF, desenhe as áreas de captura, configure as chaves e as expressões regulares, teste a análise e salve.
- Obter ID do modeloCopie o único GUID para o seu modelo (ou use TemplateName).
- Gerar ID de análiseCrie algo único GUID para cada operação de análise (no lado do cliente ou por meio de uma ferramenta).
:::dica Ideal para Use quando você tiver tipos de documentos recorrentes (faturas, formulários) e precisar de extração estruturada. Combine com Classificar documento Para rotear por tipo e, em seguida, analisar com o modelo correto. :::
API parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api-key | corda | Sim | Seu PDF4me API chave, Base64 codificado. Obtenha-o do painel. |
| docContent | base64 | Não | PDF conteúdo do arquivo (Base64Se omitido, o documento é obtido por docName. |
| docName | corda | Sim | PDF Nome do arquivo com extensão .pdf. |
| TemplateId | corda | Sim* | Exclusivo GUID para o modelo de análise (do painel). *Use TemplateId ou TemplateName. |
| TemplateName | corda | Não | Nome do modelo (alternativa a TemplateId). |
| ParseId | corda | Sim | Exclusivo GUID para esta operação de análise sintática. |
| async | booleano | Não | Ativar o processamento assíncrono. |
Quando usar a função Analisar Documento
- Faturas e formuláriosExtrair campos estruturados (valor, data, fornecedor) de tipos de documentos recorrentes.
- Automação de documentosUse modelos para extrair dados de fontes semelhantes. PDFs em CRM, ERPou bancos de dados.
- ConformidadeExtrair campos-chave para retenção ou auditoria de documentos padronizados.
Para esquemas de requisição/resposta e exemplos de código, consulte Analisar documento no PDF4me API documentos.
Pré-requisitos
Antes de usar este endpoint, certifique-se de que você possui:
- Um válido PDF4me API chave (Adquira o seu API Chave)
- A PDF documento em Base64 formato ou um público URL para um PDF arquivo
- A Analisar modelo criado em seu PDF4me painel (Criar modelo de análise)
- Você precisa do ID do modelo (GUID) ou Nome do modelo a partir do seu modelo de análise
- A ID de análise (GUID) para a operação de análise sintática
Formato de resposta
O API retorna um JSON Resposta com dados do documento analisados, incluindo tipo de documento, número de páginas e informações estruturadas extraídas.