Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Die Vantage-API ermöglicht es Ihnen, auf Skill-Parameter von Document-Skills und Process-Skills zuzugreifen und deren Werte für einen bestimmten Vorgang zu ändern. Parameter werden als Schlüssel-Wert-Paare vom Typ string übergeben. Über die API gesetzte Werte haben Vorrang vor den in der Vantage-UI gesetzten Werten.

​
Werte von Skill-Parametern ändern

Um die Werte von Skill-Parametern für einen Vorgang zu ändern, erstellen Sie per POST einen neuen Vorgang (oder starten Sie einen) und geben Sie die neuen Werte im skillParameters-Body an. Erstellen Sie einen leeren Vorgang: 
POST {your-host}/api/publicapi/v1/transactions
Oder starten Sie einen Vorgang, mit dem ein bestimmter Skill ausgeführt wird: 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Fügen Sie neue Parameterwerte in den Request-Body ein: 
curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"Neuer Parameter\",\"value\":\"Vendors neu\"}]}"
Ein Vorgang kann bis zu 10 Skill-Parameter als Schlüssel-Wert-Paare haben. Schlüssel sind auf 128 Zeichen begrenzt, Werte auf 256.

​
Skill-Parameterwerte abrufen

Verwenden Sie eine der folgenden Optionen, um Skill-Parameterwerte abzurufen.

​
Den Endpunkt skillParameters abfragen

Senden Sie eine GET-Anfrage: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
Antwort: 
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

​
Die Vorgangsdatei herunterladen

Senden Sie eine GET-Anfrage, um die Vorgangsdatei herunterzuladen, die Parameterwerte im JSON-Format enthält: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download

Skill-Parameter

Konfigurieren und verwalten Sie Skill-Parameter, um das Verhalten von Skills ohne erneutes Training anzupassen.

Document-Skill-Parameter

Konfigurieren Sie Parameter in einem Document-Skill für verschiedene Verarbeitungsszenarien.

Process-Skill-Parameter

Greifen Sie von einem Process-Skill aus auf Document-Skill-Parameter zu und ändern Sie sie.

Extract-Aktivität

Extrahieren Sie Feldwerte aus Dokumenten mithilfe eines Document-Skills.

Einführung in die Vantage-API

Greifen Sie über die REST-API programmgesteuert auf Vantage zu.