Analizza il documento
Estrarre → Analizza il documento
IL Analizza il documento API estrae dati strutturati da un PDF utilizzando un modello che crei nel PDF4me dashboard. Tu invii docContent (facoltativo; se omesso il documento viene recuperato da docName), docName, TemplateId GUID) O TemplateName, ParseId GUID), e facoltativamente async. IL API resi JSON con dati analizzati (tipo di documento, numero di pagine, campi estratti). Utilizza il tester qui sotto per provarlo; maggiori dettagli sono disponibili nelle sezioni successive.
Prova ad analizzare il documento API
:::nota - Guida rapida
Punto finale: POST /api/v2/ParseDocument · Necessario: api-key, docName, TemplateId (O TemplateName), ParseId
:::
Usa il modulo sottostante per inviare il tuo API chiave, PDF Base64 o citato da docName), ID o nome del modello e ID di analisi. La risposta è JSON con dati del documento analizzati. Non è richiesto alcun codice, compila i campi e fai clic Invia richiesta.
Panoramica, parametri e casi d'uso
- Overview
- Parameters
- Use cases
Che cos'è Parse Document?
Questo endpoint estrae dati strutturati da un PDF utilizzando un modello di analisi tu crei nel PDF4me dashboard. Tu fornisci il PDF docContent facoltativo, se omesso il documento viene recuperato da docName), docName, TemplateId GUID) O TemplateName, E ParseId GUID). IL API resi JSON con tipo di documento, numero di pagine e campi estratti in base alle aree di acquisizione e alle chiavi del modello.
Caratteristiche principali
- basato su modelli: Crea un modello nella dashboard: carica un esempio PDF, disegnare aree di acquisizione, configurare chiavi ed espressioni regolari.
- TemplateId O TemplateName: Utilizzare il modello GUID o il nome dalla dashboard.
- ParseId: Unico GUID per operazione di parsing (genera lato client o utilizza API-fornito).
- Output strutturato: JSON con tipo di documento, numero di pagine e dati strutturati estratti.
Recupero degli ID del modello e dell'analisi
- Accesso PDF4me Pannello di controllo: Vai al analizzare il documento pagina.
- Crea un modelloFai clic su "Aggiungi", inserisci un nome per il modello e poi salva.
- Configura modello: Carica un modello PDF, disegnare le aree di acquisizione, configurare le chiavi e le espressioni regolari, testare l'analisi sintattica e salvare.
- Ottieni l'ID del modello: Copia l'unico GUID per il tuo modello (oppure usa TemplateName).
- Genera ID di analisi: Crea un unico GUID per ogni operazione di analisi sintattica (lato client o tramite uno strumento).
:::suggerimento Ideale per Da usare quando si hanno tipi di documenti ricorrenti (fatture, moduli) e si necessita di un'estrazione strutturata. Da combinare con Classifica il documento Instradamento per tipo, quindi analisi con il modello corretto.
:::
API parametri
| Parametro | Tipo | Necessario | Descrizione |
|---|---|---|---|
| api-key | corda | SÌ | Tuo PDF4me API chiave, Base64 codificato. Prendilo da pannello di controllo. |
| docContent | base64 | NO | PDF contenuto del file (Base64). Se omesso, il documento viene recuperato da docName. |
| docName | corda | SÌ | PDF Nome del file con estensione .pdf. |
| TemplateId | corda | SÌ* | Unico GUID per il modello di analisi (dalla dashboard). *Usa TemplateId O TemplateName. |
| TemplateName | corda | NO | Nome del modello (alternativa a TemplateId). |
| ParseId | corda | SÌ | Unico GUID per questa operazione di analisi sintattica. |
| async | booleano | NO | Abilita l'elaborazione asincrona. |
Quando utilizzare Analizza documento
- Obiettivi e moduliEstrarre i campi strutturati (importo, data, fornitore) dai tipi di documento ricorrenti.
- Automazione dei documenti: Utilizzare modelli per estrarre dati da simili PDFs in CRM, ERPo database.
- ConformitàEstrarre i campi chiave da conservare o verificare da documenti standardizzati.
Per schemi di richiesta/risposta ed esempi di codice, vedere Analizza il documento nel PDF4me API documenti.
Prerequisiti
Prima di utilizzare questo endpoint, assicurati di avere:
- Un valido PDF4me API chiave (Ottieni il tuo API Chiave)
- UN PDF documento in Base64 formato o pubblico URL a PDF file
- UN Analizza il modello creato nel tuo PDF4me pannello di controllo (Crea modello di analisi)
- Hai bisogno del ID del modello GUID) O Nome del modello dal tuo modello di analisi
- UN Analizza ID GUID) per l'operazione di analisi sintattica
Formato di risposta
IL API restituisce un JSON Risposta contenente i dati del documento analizzati, inclusi il tipo di documento, il numero di pagine e le informazioni strutturate estratte.