REST APIエンドポイントに指定のFormデータをPOSTすると分類結果のJSONを応答します。入力画像一枚につき1回APIをリクエストする必要があります。 処理に成功するとHTTPstatus200のステータスコードと共にJSONが応答されます。

・エンドポイント

・ボディ

リクエストボディは Content-Type: multipart/form-data 形式でリクエストを送信します。

• ・format
    ID のフォーマットを正規表現で指定してください。ただし、以下の場合はエラーとなります。
    ・"+", "*"が含まれていた場合
    ・中カッコ内の数値（{n}および{m,n}のn）の和が一定数以上の場合（一定数はモデルファイルにて指定されます）
    ・正規表現のマッチング処理が規定時間以上経過した場合(タイムアウト値はモデルファイルにて指定されます)

• ・image
    分類する画像ファイルです。対応しているフォーマットはJPEG、png、bmp、gif、tiffです。

• ・searchMethod
     numOfSearch  が小さいときはbeam_search  、大きくするならk_shortest_path  としてください。
    デフォルトではbeam_search です。

• ・numOfSearch
    何個まで探索を行うかを指定します。処理速度に大きく影響します。
    値の範囲は最小が1、最大で10000です。デフォルト値は100です。

• ・numOfCandidates
    何個まで候補を返却するかを指定します。
    値の範囲は最小が1、最大で100です。デフォルト値は1です。

• ・targetRegion
    画像中の指定した領域のみを切り出し、当該領域のみに画像認識処理を行います。
    切り出す領域のleft, top, right, bottomの座標を「,」区切りで指定します。座標の値は整数で入力してください。

• ・writingDirection
    認識する文字列の方向を設定します。
    入力画像の文字列方向が横書きの場合、horizontalを、縦書きの場合、verticalを、自動判定させたい場合、autoを設定してください。自動判定では、入力画像の横幅＜縦幅の場合縦書きと判定します。
    未指定時はモデルファイルの設定値を用います。

• ・サンプル

  ------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="format" ^(a-z|A-Z|0-9){4}$
※任意の英数字4ケタ固定の場合
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="image"; filename="sample.png"
Content-Type: image/png 画像データ(binary)
------WebKitFormBoundaryhwZz6hhFHARN6wAB—
Content-Disposition: form-data; name="searchMethod"
beam_search
------WebKitFormBoundaryhwZz6hhFHARN6wAB—
Content-Disposition: form-data; name="numOfSearch"
100
------WebKitFormBoundaryhwZz6hhFHARN6wAB—
Content-Disposition: form-data; name="numOfCandidates"
3
------WebKitFormBoundaryhwZz6hhFHARN6wAB—
Content-Disposition: form-data; name="targetRegion"
1,5,10,50
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="writingDirection"
horizontal
------WebKitFormBoundaryhwZz6hhFHARN6wAB

・ボディ

• ・jobId
    画像検出の一意な処理IDです。

• ・status
    処理状態です。
    状態は以下の通りです。

  Status	意味
  SUCCESS	成功

• ・writingDirection
    画像を縦書き横書きどちらで認識したのかを出力します。
    横書きとして認識した場合horizontalを、縦書きとして認識した場合varticalをそれぞれ出力します。

• ・searchSucceed
    認識結果の正規表現でのマッチング処理でタイムアウトが発生せずに処理完了したか出力します。
    マッチング処理完了の場合trueを、マッチング処理タイムアウトの場合falseをそれぞれ出力します。

• ・candidates
    認識結果の文字列とスコアをスコアの高い順にオブジェクトとして出力します。
    candidates object

  JSONキー	値	必須
  score	浮動小数点数	○
  character	文字列	○
  match	ブール値	○

• ・score
    認識結果に対する適合度を示します。

• ・character
    認識された結果の文字列です。

• ・match
    認識結果がformat にマッチしているかを表示します。
    true の場合マッチしています。 false  の場合マッチしていません。

 

• ・サンプル

  {
   "jobId":"abcde",
   "status": "success",
   "writingDirection":"horizontal",
   "searchSucceed":true,
   "candidates":[
      {
         "score": 0.748669934272766,
         "character": "ABCD",
         "match": True
      },
      {
         "score": 0.07307015359401703,
         "character": "WXYZ",
         "match": False
      }
   ]
}