Verarbeiten von Dokumenten mit einem einzelnen API-Aufruf

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:

Abrufen einer Liste aller verfügbaren Skills
Erstellen und Starten eines Vorgangs
Überwachen des Vorgangsstatus
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:

GET https://vantage-us.abbyy.com/api/publicapi/v1/skills

GET https://vantage-eu.abbyy.com/api/publicapi/v1/skills

GET https://vantage-au.abbyy.com/api/publicapi/v1/skills

Führen Sie den folgenden Befehl aus: Für Windows:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

Für Linux:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

Die Antwort enthält eine JSON-Datei, die etwa wie folgt aussieht: Antwort:

[
   {
      "id": "Receipt",
      "name": "Receipt",
      "type": "Document"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "NewClassifier",
      "type": "Classification"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "Invoice",
      "type": "Document"
   }
]

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 zur Verarbeitung einer hochgeladenen Datei mit einem bestimmten Skill zu erstellen und zu starten, senden Sie die folgende POST-Anfrage an die Ressource transactions/launch?skillId=<skill-id>:

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

Dadurch wird ein neuer Vorgang erstellt und sofort gestartet. Führen Sie den folgenden Befehl aus: Für Windows:

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

Für Linux:

curl -X POST 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

curl -X POST 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

curl -X POST 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

Beim Hochladen der Datei in Vantage werden alle folgenden Zeichen im Dateinamen durch einen Unterstrich ersetzt: :/?#[]@!$&'()*+,;=\. Der geänderte Dateiname wird sowohl in der Vantage-API als auch in 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 abzufragen), senden Sie eine GET-Anfrage an die Ressource transactions/<transaction_id> mit der Vorgangs-ID im Anfrage-URI:

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id

Führen Sie den folgenden Befehl aus: Für Windows:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

Für Linux:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

Die Antwort sieht etwa wie folgt aus: Antwort:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

Die Antwort enthält:

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:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "resultFiles": [
            {
               "fileId": "3a3e6245-48e1-489a-9fef-a10b5ba28515",
               "type": "Json"
            }
         ],
         "businessRulesErrors": []
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

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:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "classification": {
            "isResultClassConfident": true,
            "resultClass": {
               "id": "8f2a51d4-6c0b-4e2a-9d3e-5b7c1a9f0e64",
               "name": "Invoice"
            },
            "classConfidences": [
               {
                  "classId": "8f2a51d4-6c0b-4e2a-9d3e-5b7c1a9f0e64",
                  "className": "Invoice",
                  "confidence": 89
               },
               {
                  "classId": "2c9d7e01-4b3a-4f6c-8a15-d0e6f2b8c473",
                  "className": "PurchaseOrder",
                  "confidence": 32
               }
            ]
         }
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

Extrahieren Sie die Klasse des Dokuments aus dem Schlüssel resultClass.name und prüfen Sie den Konfidenzwert jeder wahrscheinlichen Klasse in den Schlüsseln confidence (eine ganze Zahl von 0 bis 100). Bei einem Process-Skill kann die Antwort je nach den im Process-Skill verfügbaren Verarbeitungsstufen alle oder einige der Informationen enthalten, die für Document- 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:

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

Führen Sie den folgenden Befehl aus: Für Windows:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

Für Linux:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

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, Dokuments und der Datei aus der letzten Antwort an:

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

Führen Sie den folgenden Befehl aus: Für Windows:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

Für Linux:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

Die Antwort enthält die Datei im Binärformat. Wiederholen Sie diesen Schritt für alle 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):

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

Führen Sie den folgenden Befehl aus: Für Windows:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

Für Linux:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

Übersicht

Entwicklerhandbuch

Verarbeiten von Dokumenten mit einem einzelnen API-Aufruf

Abrufen einer Liste aller verfügbaren Skills

Erstellen und Starten eines Vorgangs

Überwachung des Vorgangsstatus

Herunterladen von Quell- und Ergebnisdateien

Quelldateien

Ergebnisdateien

​Abrufen einer Liste aller verfügbaren Skills

​Erstellen und Starten eines Vorgangs

​Überwachung des Vorgangsstatus

​Herunterladen von Quell- und Ergebnisdateien

​Quelldateien

​Ergebnisdateien

Abrufen einer Liste aller verfügbaren Skills

Erstellen und Starten eines Vorgangs

Überwachung des Vorgangsstatus

Herunterladen von Quell- und Ergebnisdateien

Quelldateien

Ergebnisdateien