Dokument klassifizieren
Extrakt → Dokument klassifizieren
Der Dokument klassifizieren API analysiert ein PDF und gibt Klassifizierungsdaten (Dokumenttyp, Kategorie, Metadaten) zurück. Sie senden die PDF als Base64 (docContent), docNameund optional async. Der API Rückgaben JSON mit Dokumenttyp, Kategorie und zugehörigen Metadaten. Nutzen Sie den Tester unten, um es auszuprobieren; weitere Details finden Sie in den folgenden Abschnitten.
Probieren Sie die Funktion „Dokument klassifizieren“ aus. API
:::Hinweis Kurzübersicht
Kurzübersicht
Endpunkt: POST /api/v2/ClassifyDocument · Erforderlich: api-key, docContent, docName
:::
Nutzen Sie das untenstehende Formular, um Ihre Anfrage zu senden API Schlüssel und PDF (Base64Die Antwort lautet: JSON mit Klassifizierungsdaten (Dokumenttyp, Kategorie, Metadaten). Kein Code erforderlich, Felder ausfüllen und klicken Anfrage senden.
Überblick, Parameter und Anwendungsfälle
- Overview
- Parameters
- Use cases
Was ist ein klassifiziertes Dokument?
Dieser Endpunkt analysiert eine PDF und gibt Klassifizierungsdaten zurück: Dokumenttyp, Kategorie und Metadaten. Sie stellen die PDF (Base64) und optional aktivieren async; Die API Rückgaben JSON Nutzen Sie das Klassifizierungsergebnis, um Dokumenttypen zu identifizieren oder Dokumente in Arbeitsabläufen weiterzuleiten.
Hauptmerkmale
- Dokumentenanalyse: Der API Analysiert Inhalte, um Dokumenttypen und -kategorien zu klassifizieren und zu identifizieren.
- JSON AntwortDokumenttyp, Kategorie und Metadaten in einem strukturierten Format.
- Asynchron: Verwenden async für größere PDFs um Timeouts zu vermeiden.
:::Tipp Ideal für Verwenden Sie diese Funktion, wenn Sie Dokumenttypen (z. B. Rechnungen, Verträge, Formulare) identifizieren oder Dokumente nach Kategorie weiterleiten müssen. Kombinieren Sie sie mit Dokument analysieren zur vorlagenbasierten Extraktion nach der Klassifizierung.
:::
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 | Ja | PDF Dateiinhalt (Base64). |
| docName | Zeichenkette | Ja | PDF Dateiname mit der Erweiterung .pdf. |
| async | boolescher Wert | NEIN | Asynchrone Verarbeitung aktivieren. |
Wann sollte man die Funktion „Dokument klassifizieren“ verwenden?
- DokumentenweiterleitungEingehende Nachrichten klassifizieren PDFs (Rechnungen, Verträge, Formulare) und leiten sie an den richtigen Workflow weiter.
- Konformität und Indexierung: Dokumenttyp für Aufbewahrung oder Suche festlegen.
- Vorverarbeitung: Dokumenttyp vor dem Dokument analysieren oder Formulardaten extrahieren PDFDie
Für Anfrage-/Antwortschemata und Codebeispiele siehe Dokument klassifizieren 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
Antwortformat
Der API gibt ein zurück JSON Antwort mit Klassifizierungsdaten einschließlich Dokumenttyp, Kategorie und Metadateninformationen.