ASWI - Pokročilé softwarové inženýrství » ASWI 2020 » Indexace a fulltextové vyhledávání v historických obrazových dokumentech (KIV) - ANONYMOUS

h1. Komunikační protokol (v.1)

* Jednotlivé zprávy budou zasílány ve fromátu JSON

* Komunikace bude probíhat pomocí HTTP protokolu

* Budou využívány návratové HTTP kódy stavů (200, 400, 500, atd.)

* Návrh komunikace na obrázku níže.

!kom_protokol.png!

h2. REST API - URL

* */search*: POST => hledání výrazu v dokumentech

* */documents*: POST => přídání nového dokumentu a obrázku

* */documents*: GET   => vypsání všech dokumemtů (název, datum, atd.) jen základní info

* */documents/{název dokumentu}*: GET   => získání obrázku k danému dokumentu

* Struktura jednotlivých zpráv

** Query request: /search : POST

<pre><code class="json">

{ 

	"query": "hledaný výraz", 

	"date": "čas odeslání dotazu"

	"enableSpellCheck": "logická hodnota, která určuje, zda se používá spell check" 

}

</code></pre>

** Query response: /search : POST

<pre><code class="json">

{

   "exression":"hledaný výraz",

   "TextRegion":{

      "imageCut":"výřez dokumentu v Base64",

      "regionCoords": "koordináty regionu",

      "regionText":"text region",

      "documentName":"název dokumentu",

      "documentSize":"původní velikost oříznutého dokumentu",

      "randomId":"textový řetězec představující random id pro každý výsledek"  

      "textLines":[

         {

            "lineText":"text line 1",

            "lineCoord":"koordináty řádky",

            "textWords":[

               {

                  "wordText":"text word 1",

                  "wordCoords":"koordináty slova"

               }

            ]

         }

      ]

   }

}

</code></pre>

** Documents resposne: /documents : GET

<pre><code class="json">

[

	"id": "id dokumentu", 

	"documentName": "název dokumentu",

	"originDate": "datum původu dokumentu",

	"uploadedDate": "datum nahrání dokumentu" 

]

</code></pre>