概要

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

リクエスト

• ・エンドポイント

  POST https://irp.dcm-dc.biz/recognize?auth_key={APIKEY}
   

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

• ・ボディ

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

  multipartキー	値	必須
  image	画像ファイルのバイナリ	○

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

  • ・サンプル

    ------WebKitFormBoundaryhwZz6hhFHARN6wAB--
Content-Disposition: form-data; name="image"; filename="sample.png"
Content-Type: image/png
画像データ(binary)
------WebKitFormBoundaryhwZz6hhFHARN6wAB--


レスポンス

• ・ボディ

• JSONキー	値	必須
  Version	文字列	○
  Status	文字列	○
  RecognitionID	文字列	○
  Candidates	object配列

• ・Version
  物体認識 API のプロトコルバージョン です。

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

• Status	意味
  SUCCESS	成功
  ILLEGAL_REQUEST	リクエスト、あるいは投稿された画像に問題がある場合
  INTERNAL_ERROR	認識エンジン側でエラーが発生した場合

• ・RecognitionID
  認識結果に対するフィードバックを行うため、 送信した画像と、その認識結果を結びつける ID です。

• ・Candidates
  分類結果のcandidates objectをスコアの高い順にソートして配列で設定します。

• JSONキー	値	必須
  Label	文字列	○
  Score	実数	○
  InlierPatchCount	実数
  Coordinates	文字列
  Mappings	object配列

• ・Label
  分類した画像の識別名です。
• ・Score
  分類した画像の精度を表します。値の範囲は-2147483648～2147483647です。
• ・PatchCount
  入力画像と教師画像とでマッチングしたキーポイントの個数を表します。
• ・InlierPatchCount
  入力画像と教師画像とでマッチングして、なおかつ位置関係に整合性があるキーポイントの個数を表します。
• ・Cooridinates
  Mapping 要素の座標系を示します。
• ・Mappings
  分類した画像のタグ名です。
• ・Mappings object

• JSONキー	値
  Type	文字列
  X	実数
  Y	実数

• ・Type
  Mapping の種類が表示されます。たとえば、 point などと表示されます。
• ・X
  Mapping の X 座標が表示されます。
• ・Y
  Mapping の Y 座標が表示されます。
• ・サンプル

{
   "Version": "4.1",
   "RecognitionID": "some-recognition-id-is-shown",
   "Status": "SUCCESS",
   "Candidates": [
     {
       "Label": "8",
       "Score": 57,
       "PatchCount": 26,
       "InlierPatchCount": 0,
       "Coordinates": "QUERY_IMAGE_CORNERS_IN_TRAIN_COORDINATES",
       "Mappings": [
         {
           "Type": "point",
           "X": 0,
           "Y": 0
         },
         {
           "Type": "point",
           "X": 0,
           "Y": 0
         },
         {
           "Type": "point",
           "X": 0,
           "Y": 0
         },
         {
           "Type": "point",
           "X": 0,
           "Y": 0
         }
       ]
     }
   ]
 }