REST API

Mantiseinträge

 3212

Systemtyp

 69 

Eintrittsinvarianz

JA

Beschreibung

OJOHZDORestApi

Wurde als Pilotprojekt für die Parashift API entwickelt und wird aktuell nur im Zusammenhang mit AI Feldextraktion von Dokumenten verwendet.

Die verfügbaren API's werden nun auf Micorsoft Azure weiterentwickelt.

Der Arbeitsschritt stellt eine Verbindung zu einer WEB-API her, und führt von der API zur verfügung gestellte Befehle aus.

Damit können z.B.:

• Dateien hochgeladen werden
• Metadaten übermittelt (aktuell nur abholung) werden
• Externe Prozesse verfolgt oder gesteuert werden

Weitere Zugehörige Arbeitsschritte

Quittierung - Warten Schritt, welcher auf eine Bestätigung der Gegenstelle wartet. z.B. wenn alle Metadaten bereistehen.

Konfiguration

Das Konfigurationsfenster besteht jeweils aus zwei Teilen:

• Auswahl und Konfiguration des API Anbieter
• Auswahl und Konfiguration eines verfügbaren API Befehls

Die Konfiguration ist je nach Anbieter unterschiedlich. In der Regel verlangt jeder Anbieter eine Authentifizierung und Authorisierung. Dies wird meistens in Form einers API-Keys (Token) gehandhabt.

Ein Wechsel zwischen Anbieter und/oder Befehlen hat die Löschung der aktuellen Konfiguration zur Folge und muss deshalb zusätzlich bestätigt werden.

Verfügbare Anbieter

Microsoft Azure Document Intelligence

API Konfiguration

Die API benötigt eine Endpunkt URL (API Pfad) und ein API Key.

Siehe: Anleitung für Azure Document Intelligence

API Befehle

TODO

Parashift

API Konfiguration

Die API verlangt aktuell nur nach einem API Key. Dieser ist in das entsprechende Feld einzugeben und muss beim API Provider erstellt werden.

API Befehle

Dokumente upload

Lädt Dateien zu einem Parashift Workflow hoch. Bei PDF Dateien können zusätzlich die zu berücksichtigenden Seitenzahlen angegeben werden.

Felder:

Interne ID - Helper Objektidentifikation, Standard = DOSEQ. Aktuell möglich sind DOSEQ, DOSIGNATUR.

Objektname - Der Name für das Objekt, wird auf der Parashift Webseite entsprechend zur identifikation verwendet. Verwendet Platzhalter, erlaub sind [DOSEQ], [DOSIGNATUR] und [FILENAME]

Klassifizierungsscope - Weist ein Objekt direkt einer Klassifizierung zu. Überspringt die Erkennung des Dokumentetyps auf der Gegenseite. Ist der Scope bekannt, sollte das Feld entsprechend gefüllt werden. Erlaubt die Angabe mehrerer möglicher Scopes als Kommagetrennte Werte (e.g.: Einwohnerkarten, Haustierkarten, XYKarten)

Upload Konfiguration - Ist auf der Gegenstelle im Web-UI für den entsprechenden Workflow / Projekte zu Konfigurieren. Standard=client

Validierung erforderlich - Standard = nein. Gibt an, ob Objekte bei der Verarbeitung zusätzlich manuell validiert werden müssen.

Nicht für Training verwenden - Standard = ja. Gibt an, ob das Objekt für das Training des Erkennungsalgorhytmus verwendet werden soll.

Seitennummer(n) - Kommagetrennte Liste mit den zu berücksichtigenden Seitennummern. Bei PDF werden nur die angegebene Seitennummern aus einem Dokument übermittelt. Bei Bildern entsprechend nur die der Sortierreihenfolge nach Dateiname enstsprechenden Dateien. Standard = leer (alle Seiten senden)

Dateityp - Welche Art von Dateien werden beim Upload berücksichtigt?

Metadaten abholen

Holt die bei Parashift ermittelten Metadaten ab und speichert diese in den zugehörigen Attributen.

Varianten:

'Standard: Provider ID' - Verwendet zum finden des zugehörigen Dokuments die Dokumente ID der Gegenstelle (Feld = DO_ISQ). Diese ID ist eindeutig, es können somit mehrfache Objekte mit der gleichen Helper ID (DO_SEQ) existieren.

'Helper ID' - Verwendet zum finden des zugehörigen Dokuments die Objekt ID aus dem Helper (Feld = DO_SEQ)
WICHTIG: Wenn die DO_SEQ als ID zum ermitteln eines hochgeladenen Objektes verwendet wird, dann muss sichergestellt werden, dass dieses Objekt nicht mehrfach hochgeladen wurde. Bzw. es darf dann bei Parashift nicht mehr als ein Objekt gleichzeitig mit der selben Helper ID existieren. Alle duplikate müssen auf der Parashift Plattform zuerst gelöscht worden sein.

Konfiguration:

Für jedes zu importierende Metadatum muss eine Zeile in der Tabelle erstellt werden, welches den Attributsnamen im Helper mit dem Attributsnamen der Gegenstelle mapped. Gross-Kleinschreibung beachten!

Wird die Option "Ist Pflicht" ausgewählt, dann darf das empfangene Attribut nicht leer sein. Die Objekte gehen sonst in Fehlerstatus.