Analyser le document
Extrait → Analyser le document
Le Analyser le document API extrait des données structurées d'un PDF en utilisant un modèle que vous créez dans le PDF4me tableau de bord. Vous envoyez docContent (facultatif ; si omis, le document est récupéré par docName), docName, TemplateId (GUID) ou TemplateName, ParseId (GUID), et éventuellement async. Le API retours JSON avec les données analysées (type de document, nombre de pages, champs extraits). Utilisez l'outil de test ci-dessous pour l'essayer ; vous trouverez plus de détails dans les sections suivantes.
Essayez l'analyse du document API
Point final : POST /api/v2/ParseDocument · Requis: api-key, docName, TemplateId (ou TemplateName), ParseId
Utilisez le formulaire ci-dessous pour envoyer votre API clé, PDF (Base64 ou mentionné par docName), l'identifiant ou le nom du modèle, et l'identifiant d'analyse. La réponse est JSON avec les données du document analysées. Aucun code requis, remplissez les champs et cliquez Envoyer une requête.
Aperçu, paramètres et cas d'utilisation
- Overview
- Parameters
- Use cases
Qu'est-ce que l'analyse de document ?
Ce point de terminaison extrait des données structurées d'un PDF en utilisant un modèle d'analyse vous créez dans le PDF4me tableau de bord. Vous fournissez le PDF (docContent facultatif ; si omis, le document est récupéré par docName), docName, TemplateId (GUID) ou TemplateName, et ParseId (GUID). Le API retours JSON avec le type de document, le nombre de pages et les champs extraits en fonction des zones de capture et des clés de votre modèle.
Caractéristiques principales
- Basé sur des modèlesCréez un modèle dans le tableau de bord : téléchargez un exemple PDF, dessiner les zones de capture, configurer les clés et les expressions régulières.
- TemplateId ou TemplateNameUtilisez le modèle GUID ou le nom du tableau de bord.
- ParseId: Unique GUID par opération d'analyse (générer côté client ou utiliser API-fourni).
- Sortie structurée: JSON avec le type de document, le nombre de pages et les données structurées extraites.
Obtention des identifiants de modèle et d'analyse
- Accéder PDF4me Tableau de bordAllez à analyser le document page.
- Créer un modèleCliquez sur « Ajouter », saisissez un nom de modèle, puis enregistrez.
- Configurer le modèle: Télécharger un modèle PDF, dessiner les zones de capture, configurer les clés et les expressions régulières, tester l'analyse syntaxique et enregistrer.
- Obtenir l'ID du modèleCopiez l'unique GUID pour votre modèle (ou utilisez TemplateName).
- Générer un ID d'analyseCréez un unique GUID pour chaque opération d'analyse (côté client ou via un outil).
Conseil : Idéal pour
À utiliser lorsque vous avez des types de documents récurrents (factures, formulaires) et que vous avez besoin d'une extraction structurée. À combiner avec Classer les documents Acheminer par type, puis analyser avec le modèle approprié.
:::
API paramètres
| Paramètre | Taper | Requis | Description |
|---|---|---|---|
| api-key | chaîne | Oui | Ton PDF4me API clé, Base64 encodé. Récupérez-le depuis le tableau de bord. |
| docContent | base64 | Non | PDF contenu du fichier (Base64). Si omis, le document est récupéré par docName. |
| docName | chaîne | Oui | PDF Nom du fichier avec l'extension .pdf. |
| TemplateId | chaîne | Oui* | Unique GUID pour le modèle d'analyse (à partir du tableau de bord). *Utiliser TemplateId ou TemplateName. |
| TemplateName | chaîne | Non | Nom du modèle (alternative à TemplateId). |
| ParseId | chaîne | Oui | Unique GUID pour cette opération d'analyse. |
| async | booléen | Non | Activer le traitement asynchrone. |
Quand utiliser l'analyse de document
- Factures et formulairesExtraire les champs structurés (montant, date, fournisseur) des types de documents récurrents.
- Automatisation des documentsUtilisez des modèles pour extraire des données similaires. PDFs dans CRM, ERPou des bases de données.
- ConformitéExtraire les champs clés à des fins de conservation ou d'audit à partir de documents normalisés.
Pour les schémas de requête/réponse et des exemples de code, voir Analyser le document dans le PDF4me API documents.
Prérequis
Avant d'utiliser ce point de terminaison, assurez-vous d'avoir :
- Un valide PDF4me API clé (Obtenez votre API Clé)
- UN PDF document dans Base64 format ou public URL à un PDF déposer
- UN Modèle d'analyse créé dans votre PDF4me tableau de bord (Créer un modèle d'analyse)
- Vous avez besoin du ID du modèle (GUID) ou Nom du modèle à partir de votre modèle d'analyse
- UN Analyser l'ID (GUID) pour l'opération d'analyse
Format de réponse
Le API renvoie un JSON Réponse contenant les données du document analysées, notamment le type de document, le nombre de pages et les informations structurées extraites.