物体検出

概要

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

  • overlap
    overlap = 2つの矩形の積集合の面積 / 2つの矩形の和集合の面積 です。このオーバーラップ値の閾値を上回った場合に、スコアが大きい方の矩形の情報のみを返却します。値の範囲は0.0〜1.0です。

  • threshold
    スコアがthresholdを上回った矩形だけを返却します。値の範囲は0.0〜1.0です。

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

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

  • サンプル

    ------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="overlap"
0.3
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="threshold"
0.3
------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	実数	○
  xMin	実数	○
  yMin	実数	○
  xMax	実数	○
  yMax	実数	○

  • tag
    検出した物体のタグ名です。
  • score
    検出した物体の精度を表します。値の範囲は0.0〜1.0です。
  • xMin
    検出した矩形の左上x座標です。
  • yMin
    検出した矩形の左上y座標です。
  • xMax
    検出した矩形の右下x座標です。
  • yMax
    検出した矩形の右下y座標です。

• サンプル

  {
    "jobId": "20200713101016366_10080",
    "status": "success",
    "candidates": [
        {
            "tag": "cat",
            "score": 0.9996671676635742,
            "xMin": 334.62042236328125,
            "yMin": 66.42976379394531,
            "xMax": 420.01275634765625,
            "yMax": 160.2348175048828
        }
    ]
}