一般物体認識

概要

 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キー	値	必須
  lang	整数
  image	画像ファイルのバイナリ	○
  targetRegion	文字列

  • lang
    タグが複数の言語で登録してある場合に集計するタグの登録番号を指定します。最初に登録してある言語が0番です。登録してある言語の数よりlangの値が大きい時は0番目の言語を集計します。

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

  • targetRegion
    imageの画像の中でtargetRegionの領域だけを分類対象とします。フォーマットは対象領域のLeft、Top、Right、Bottomの整数座標を , 区切りで指定します。

  • サンプル

    ------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="lang "
0
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="image"; filename="sample.png"
Content-Type: image/png
画像データ(binary)
------WebKitFormBoundaryhwZz6hhFHARN6wAB--
Content-Disposition: form-data; name="targetRegion"
1,5,10,50
------WebKitFormBoundaryhwZz6hhFHARN6wAB

• •  

レスポンス

 ボディ

JSONキー	値	必須
jobId	文字列	○
status	文字列	○
candidates	object配列	○

• jobId
  一意の処理IDです。フォーマットは yyyymmddhhmmssfff_APIID です。

• status
  処理状態です。

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

• candidates object

  JSONキー	値	必須
  tag	文字列	○
  score	実数	○

  • tag
    分類した画像のタグ名です。
  • score
    分類した画像の精度を表します。値の範囲は0.0〜1.0です。

• サンプル

  {
    "jobId":"abcde",
    "status": "success",
    "candidates":[
        {
            "tag": "car",
            "score": 0.8666
        },
        {
            "tag": "yoga",
            "score": 0.8666
        },
        {
            "tag": "train",
            "score": 0.8666
        },
        {
            "tag": "meal",
            "score": 0.8666
        }
    ]
}