文字認識

概要

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

リクエスト

•  エンドポイント

 POST https://imagepf.dcm-dc.biz/api/predict?auth_key={APIKEY}

key	値	必須	説明
APIKEY	文字列	○	払い出したAPIキーを設定します

• ボディ

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

multipartキー	値	必須
format	文字列
image	画像ファイルのバイナリ	○
searchMethod	文字列
numOfSearch	整数
numOfCandidates	整数
targetRegion	整数の配列

• 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の座標を「,」区切りで指定します。座標の値は整数で入力してください。

• サンプル

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

レスポンス

 ボディ

key	値	必須
jobid	文字列	○
status	文字列	○
candidatates	オブジェクト配列	〇

• jobid
画像検出の一意な処理IDです。
• status
処理状態です。
状態は以下の通りです。


Status	意味
SUCCESS	成功

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

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

• score
認識結果に対する適合度を示します。
• character
認識された結果の文字列です。
• match
認識結果が format にマッチしているかを表示します。
 true の場合マッチしています。 false の場合マッチしていません。

• サンプル

  {
     "candidates": [
          {
              "match": false,
              "score": 0.8893365757546245,
              "character": "o"
          }
      ],
      "jobId": "20210317170011619_1644?saveFlag=false",
      "status": "success"
  }