×

Analisi del layout | API

L'avvio di processi di analisi del layout tramite l'API può essere fatto con richieste POST a

https://transkribus.eu/TrpServer/rest/LA

I seguenti parametri di query sono disponibili su questo endpoint:

  • collIdl'ID di raccolta con i documenti che si desidera elaborare
  • doBlockSeg
    • true -> il layout esistente sarà cancellato
    • false (predefinito) -> mantenere le regioni dei blocchi di testo esistenti
  • doLineSeg
    • true (predefinito) -> rileva le linee nei blocchi di testo
    • false -> mantenere le linee esistenti
  • doPolygonToBaseline
    • true -> ispeziona i poligoni delle linee e aggiunge linee di base
    • false (predefinito) -> mantenere le linee di base esistenti
  • doBaselineToPolygon
    • true -> estrapolare nuovi poligoni di linee dalle linee di base
    • false (predefinito) -> salta
  • jobImpllo strumento da usare, il default (omettere questo parametro) è "CITlabAdvancedLaJob" che è raccomandato per la maggior parte dei documenti

Il request body specifica le pagine da elaborare, in termini di ID del documento e ID della pagina. Opzionalmente, un ID di trascrizione (tsId) può specificare una versione di trascrizione e gli ID degli elementi della regione XML PAGE possono essere passati per elaborare sezioni specifiche di una pagina. L'endpoint accetta JSON o XML:

{
   "docList" : {
      "docs" : [ {
         "docId" : 1543,
         "pageList" : {
            "pages" : [ {
               "pageId" : 1234,
               "regionIds" : [ "the_xml_id_of_a_text_region" ]
            }, {
               "pageId" : 12345,
               "tsId" : 1234567
            } ]
         }
      } ]
   }
}

Rappresentazione XML equivalente:

<?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>

Se ha successo (codice di stato HTTP 200), la risposta conterrà un oggetto di stato del lavoro con un jobId che può essere usato per monitorare il progresso (vedere Lavoro API).