Das Starten von Layout-Analyseprozessen über die API kann mit POST-Anfragen an
https://transkribus.eu/TrpServer/rest/LA
Die folgenden Abfrageparameter sind an diesem Endpunkt verfügbar:
collId
: die Sammel-ID mit den Dokumenten, die Sie verarbeiten möchtendoBlockSeg
true
-> bestehendes Layout wird gelöschtfalse
(Standard) -> vorhandene Textblockbereiche beibehalten
doLineSeg
true
(Standard) -> Zeilen in Textblöcken erkennenfalse
-> bestehende Linien beibehalten
doPolygonToBaseline
true
-> Linienpolygone prüfen und Grundlinien hinzufügenfalse
(Standard) -> vorhandene Grundlinien beibehalten
doBaselineToPolygon
true
-> Extrapolation neuer Linienpolygone aus Grundlinienfalse
(Standard) -> Überspringen
jobImpl
TranskribusLAJob": das zu verwendende Tool, Standard (diesen Parameter weglassen) ist "TranskribusLAJob", das für die meisten Dokumente empfohlen wird
Der Anfragekörper spezifiziert die zu verarbeitenden Seiten in Form von Dokument-IDs und Seiten-IDs. Optional kann eine Transkript-ID (tsId) eine Transkriptionsversion angeben und PAGE XML-Region-Element-IDs können für die Verarbeitung bestimmter Abschnitte einer Seite übergeben werden. Der Endpunkt akzeptiert JSON oder XML:
{ "docList" : { "docs" : [ { "docId" : 1543, "pageList" : { "pages" : [ { "pageId" : 1234, "regionIds" : [ "the_xml_id_of_a_text_region" ] }, { "pageId" : 12345, "tsId" : 1234567 } ] } } ] } }
Äquivalente XML-Darstellung:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <jobParameters> <docList> <docs> <docId>1543</docId> <pageList> <pages> <pageId>1234</pageId> <regionIds>the_xml_id_of_a_text_region</regionIds> </pages> <pages> <pageId>12345</pageId> <tsId>1234567</tsId> </pages> </pageList> </docs> </docList> </jobParameters>
Bei Erfolg (HTTP-Statuscode 200) enthält die Antwort ein Job-Status-Objekt mit einer jobId, die zur Überwachung des Fortschritts verwendet werden kann (siehe Job-API).