Zum Hauptinhalt springen
Ein typisches Szenario für die Verarbeitung von Dokumenten mit einem einzelnen API-Aufruf (um einen Vorgang zu erstellen, eine Datei hochzuladen und den Vorgang zu starten) besteht aus den folgenden Schritten:
  1. Abrufen einer Liste aller verfügbaren Skills
  2. Erstellen und Starten eines Vorgangs
  3. Überwachen des Vorgangsstatus
  4. Herunterladen von Quelldateien und Ergebnisdateien
Jede Anfrage an den Server muss Authentifizierungsinformationen enthalten. Weitere Details finden Sie unter Authentication. Verwenden Sie dieses Szenario, wenn Sie nur eine Datei mit weniger als 30 MB Größe haben und die Bilder dieser Datei nicht bearbeiten müssen.

​
Abrufen einer Liste aller verfügbaren Skills

Senden Sie dazu eine GET-Anfrage an die Ressource skills: Führen Sie den folgenden Befehl aus: Für Windows: Für Linux: Die Antwort enthält eine JSON-Datei, die etwa wie folgt aussieht: Antwort:
Legen Sie die Skill-ID fest, die Sie verwenden möchten. Detaillierte Beschreibungen der Skills finden Sie in den vordefinierten Skills.

​
Erstellen und Starten eines Vorgangs

Um einen Vorgang zum Verarbeiten einer hochgeladenen Datei mit einem angegebenen Skill zu erstellen und zu starten, senden Sie die folgende POST-Anfrage an die Ressource transactions/launch?skillId=<skill-id>: Dadurch wird ein neuer Vorgang erstellt und sofort gestartet. Führen Sie den folgenden Befehl aus: Für Windows: Für Linux:
Wenn Sie die Datei in Vantage hochladen, werden alle folgenden Zeichen im Dateinamen durch einen Unterstrich ersetzt: :/?#[]@!$&'()*+,;=\. Der geänderte Dateiname wird sowohl in der Vantage-API als auch im Skill Monitor angezeigt.

​
Überwachung des Vorgangsstatus

Um den Vorgangsstatus in einer Schleife mit kurzem Timeout zu überwachen (wir empfehlen, den Status nicht häufiger als einmal pro Sekunde zu prüfen), senden Sie eine GET-Anfrage an die Ressource transactions/<transaction_id> mit der Vorgangs-ID im Anfrage-URI: Führen Sie den folgenden Befehl aus: Für Windows: Für Linux: Die Antwort sieht etwa wie folgt aus: Antwort: In der Antwort gilt Folgendes:
  • Wenn der Wert des Schlüssels status auf Processing gesetzt ist, sind die Ergebnisse noch nicht verfügbar. Sobald sich der Status des Vorgangs in Processed ändert, können Sie die Ergebnisse herunterladen.
  • Der Schlüssel manualReviewLink enthält einen Link zur Weboberfläche des Manual Review-Clients und ein Vantage-Zugriffstoken, falls eine manuelle Überprüfung erforderlich ist. Mit diesem Link und dem Token können die Klassifizierungs- und Feldextraktionsergebnisse eines bestimmten Vorgangs überprüft und korrigiert werden. Bis die Überprüfung abgeschlossen ist, bleibt der Wert des Schlüssels status auf Processing gesetzt. Der bereitgestellte Link ist 168 Stunden gültig. Danach sollte mit derselben Methode ein neuer Link für weitere 168 Stunden erstellt und abgerufen werden. Weitere Informationen finden Sie unter Integration der manuellen Überprüfung.
Benutzer, die über diesen Link autorisiert sind, können keine anderen Dokumente oder Vorgänge anzeigen oder ändern.
Für einen Document-Skill sieht die Antwort dann etwa wie folgt aus: Antwort: Im Array documents verfügt jedes Dokument über ein Array resultFiles. Verwenden Sie dieses Array, um die Werte von fileId abzurufen. Das Format der Ausgabedateien wird durch den verwendeten Skill bestimmt. Derzeit geben alle Skills die extrahierten Felder im JSON-Format zurück. Für einen Klassifizierungs‑Skill sieht die Antwort nach der Verarbeitung der Dokumente etwa wie folgt aus: Antwort: Extrahieren Sie die Klasse des Dokuments aus dem Schlüssel resultClass und prüfen Sie den Konfidenzwert jeder wahrscheinlichen Klasse in den jeweiligen Schlüsseln confidence. Je nach den im Process-Skill verfügbaren Verarbeitungsstufen kann die Antwort bei einem Process-Skill alle oder nur einen Teil der Informationen enthalten, die für Dokument- und Klassifizierungs-Skills zurückgegeben werden.

​
Herunterladen von Quell- und Ergebnisdateien

Nach Abschluss der Verarbeitung können Sie zwei Arten von Dateien herunterladen:
  • Quelldateien — die Originaldateien, die Sie hochgeladen haben und die in ihrem ursprünglichen Binärformat zurückgegeben werden.
  • Ergebnisdateien — das Verarbeitungsergebnis: die extrahierten Daten, standardmäßig im JSON-Format (das Ausgabeformat wird durch den Skill festgelegt).
Für Quelldateien und Ergebnisdateien werden unterschiedliche Endpunkte und Datei-IDs verwendet:
  • Quelldatei — GET transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download. Die Datei-ID stammt aus der Antwort von GET transactions/<transaction-id>/documents (sourceFiles[].id).
  • Ergebnisdatei — GET transactions/<transaction-id>/files/<file-id>/download. Die Datei-ID stammt aus dem Array resultFiles in der Antwort für den Vorgangsstatus (documents[].resultFiles[].fileId).
Um eine Liste von Dokumenten mit ihren Bezeichnern abzurufen, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/documents und geben Sie die Vorgangs-ID an: Führen Sie den folgenden Befehl aus: Für Windows: Für Linux:

​
Quelldateien

Um eine benötigte Quelldatei herunterzuladen, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download und geben Sie die Bezeichner des Vorgangs, des Dokuments und der Datei an (aus der letzten Antwort): Führen Sie den folgenden Befehl aus: Für Windows: Für Linux: Die Antwort enthält die Datei im Binärformat. Wiederholen Sie diesen Schritt für alle Ihre Quelldateien.

​
Ergebnisdateien

Um eine Ergebnisdatei herunterzuladen, senden Sie eine GET-Anfrage an die Ressource transactions/<transaction-id>/files/<file-id>/download und geben Sie die Vorgangs-ID sowie die fileId der Ergebnisdatei an. Entnehmen Sie die fileId dem Array resultFiles, das beim Überwachen des Vorgangsstatus zurückgegeben wird (jeder Eintrag hat eine fileId und einen type, z. B. Json): Führen Sie den folgenden Befehl aus: Für Windows: Für Linux: