Dokument analysieren
Extrakt → Dokument analysieren
Der Dokument analysieren API extrahiert strukturierte Daten aus einem PDF mithilfe einer Vorlage, die Sie im PDF4me Dashboard. Sie senden docContent (optional; falls weggelassen, wird das Dokument von docName), docName, TemplateId (GUID) oder TemplateName, ParseId (GUID), und optional async. Der API Rückgaben JSON mit analysierten Daten (Dokumenttyp, Seitenzahl, extrahierte Felder). Nutzen Sie den unten stehenden Tester, um es auszuprobieren; weitere Details finden Sie in den folgenden Abschnitten.
Probieren Sie das Parse-Dokument aus. API
:::Hinweis Kurzübersicht
Kurzübersicht
Endpunkt: POST /api/v2/ParseDocument · Erforderlich: api-key, docName, TemplateId (oder TemplateName), ParseId
:::
Nutzen Sie das untenstehende Formular, um Ihre Anfrage zu senden API Schlüssel, PDF (Base64 oder auf die Bezug genommen wird von docName), Vorlagen-ID oder -Name und Parse-ID. Die Antwort lautet JSON mit analysierten Dokumentdaten. Kein Code erforderlich, Felder ausfüllen und klicken Anfrage senden.
Überblick, Parameter und Anwendungsfälle
- Overview
- Parameters
- Use cases
Was ist Parse Document?
Dieser Endpunkt extrahiert strukturierte Daten aus einem PDF unter Verwendung eines Vorlage analysieren Sie erstellen im PDF4me Dashboard. Sie stellen das bereit. PDF (docContent optional; wird das Dokument weggelassen, wird es von docName), docName, TemplateId (GUID) oder TemplateName, Und ParseId (GUID). Der API Rückgaben JSON mit Dokumenttyp, Seitenzahl und extrahierten Feldern basierend auf den Erfassungsbereichen und Schlüsseln Ihrer Vorlage.
Hauptmerkmale
- Vorlagenbasiert: Erstellen Sie eine Vorlage im Dashboard: Laden Sie ein Beispiel hoch PDF, Erfassungsbereiche zeichnen, Schlüssel und reguläre Ausdrücke konfigurieren.
- TemplateId oder TemplateNameVerwenden Sie die Vorlage GUID oder Name aus dem Dashboard.
- ParseId: Einzigartig GUID pro Parsing-Operation (clientseitig generieren oder verwenden API-bereitgestellt).
- Strukturierte Ausgabe: JSON mit Dokumenttyp, Seitenzahl und extrahierten strukturierten Daten.
Abrufen von Vorlagen- und Parse-IDs
- Zugang PDF4me ArmaturenbrettGehe zu Dokument analysieren Seite.
- Vorlage erstellenKlicken Sie auf „Hinzufügen“, geben Sie einen Vorlagennamen ein und speichern Sie die Vorlage.
- Vorlage konfigurieren: Laden Sie eine Vorlage hoch PDF, Erfassungsbereiche zeichnen, Schlüssel und reguläre Ausdrücke konfigurieren, den Parse testen und speichern.
- Vorlagen-ID abrufen: Kopieren Sie das eindeutige GUID für Ihre Vorlage (oder verwenden Sie TemplateName).
- Parse-ID generieren: Erstellen Sie ein einzigartiges GUID für jeden Parsing-Vorgang (clientseitig oder über ein Tool).
:::Tipp Ideal für Verwenden Sie diese Funktion, wenn Sie wiederkehrende Dokumenttypen (Rechnungen, Formulare) haben und eine strukturierte Extraktion benötigen. Kombinieren Sie sie mit Dokument klassifizieren Um nach Typ zu routen und dann mit der richtigen Vorlage zu parsen.
:::
API Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| api-key | Zeichenkette | Ja | Dein PDF4me API Schlüssel, Base64 kodiert. Holen Sie es sich von der ArmaturenbrettDie |
| docContent | base64 | NEIN | PDF Dateiinhalt (Base64Wird dieser Parameter weggelassen, wird das Dokument von folgender Methode abgerufen: docNameDie |
| docName | Zeichenkette | Ja | PDF Dateiname mit der Erweiterung .pdf. |
| TemplateId | Zeichenkette | Ja* | Einzigartig GUID für die Parse-Vorlage (aus dem Dashboard). *Verwenden TemplateId oder TemplateNameDie |
| TemplateName | Zeichenkette | NEIN | Vorlagenname (Alternative zu TemplateId). |
| ParseId | Zeichenkette | Ja | Einzigartig GUID für diesen Analysevorgang. |
| async | boolescher Wert | NEIN | Asynchrone Verarbeitung aktivieren. |
Wann sollte man Parse Document verwenden?
- Rechnungen und Formulare: Strukturierte Felder (Betrag, Datum, Lieferant) aus wiederkehrenden Dokumenttypen extrahieren.
- Dokumentenautomatisierung: Verwenden Sie Vorlagen, um Daten aus ähnlichen Quellen abzurufen. PDFs hinein CRM, ERPoder Datenbanken.
- Einhaltung: Wichtige Felder aus standardisierten Dokumenten für Aufbewahrungs- oder Prüfungszwecke extrahieren.
Für Anfrage-/Antwortschemata und Codebeispiele siehe Dokument analysieren im PDF4me API Dokumente.
Voraussetzungen
Bevor Sie diesen Endpunkt verwenden, stellen Sie sicher, dass Sie Folgendes haben:
- Ein gültiger PDF4me API Schlüssel (Hol dir deins API Schlüssel)
- A PDF Dokument in Base64 Format oder ein öffentliches URL zu einem PDF Datei
- A Parse-Vorlage erstellt in Ihrem PDF4me Armaturenbrett (Parse-Vorlage erstellen)
- Du brauchst das Vorlagen-ID (GUID) oder Vorlagenname aus Ihrer Parse-Vorlage
- A Parse-ID (GUID) für die Parsing-Operation
Antwortformat
Der API gibt ein zurück JSON Antwort mit analysierten Dokumentdaten einschließlich Dokumenttyp, Seitenzahl und extrahierten strukturierten Informationen.