組み合わせ機能

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


• ルートオブジェクトの  candidates には物体検出のレスポンスが設定され、 さらにその内部の secondAPIs に組み合わせたAPIのレスポンスが設定されます。

• ・ボディ

  JSONキー	値	必須
  jobId	文字列	○
  detectJobId	文字列	○
  status	文字列	○
  error	文字列	失敗時
  candidates	object配列	○

  • ・jobId
      複数API組合せ用コンテナの一意な処理IDです。
  • ・detectJobId
      物体検出の一意な処理IDです。
  • ・status
      処理状態です。
      状態は以下の通りです。

    Status	意味
    success	成功
    failure	失敗

  • ・error
      "status":"failure"の場合、エラーレスポンスを出力します。
  • ・candidates
      分類結果のcandidates objectをスコアの高い順にソートして配列で設定します。
  • ・candidates object
    

    JSONキー	値	必須
    tag	文字列	○
    score	実数	○
    xMin	実数	○
    yMin	実数	○
    xMax	実数	○
    yMax	実数	○
    secondAPIs	オブジェクト配列	○

  • ・tag
      分類した画像のラベルです。
  • ・score
      分類した画像の精度を表します。値の範囲は-2147483648～2147483647です。
  • ・xMin
      矩形の左上のX座標です。
  • ・yMin
      矩形の左上のY座標です。
  • ・xMax
      矩形の右下のX座標です。
  • ・yMax
      矩形の右下のY座標です。
  • ・secondAPIs
      後段APIの結果です。
  • ・secondAPI objects
    

    JSONキー	値	必須
    apiName	文字列	○
    jobId	文字列	○
    status	文字列	○
    error	文字列	失敗時
    candidates	オブジェクト配列	○

    • ・apiName
        後段APIの名称です。
    • ・jobId
        後段APIの処理IDです。
    • ・status
        後段APIの処理ステータスです。"success", "failure"などがあります。
    • ・error
        "status":"failure"の場合、エラーレスポンスを出力します。
    • ・candidates
        後段APIの処理結果がオブジェクト配列の形で返却されます。
        具体的な内容につきましては、各APIに準拠しますので、それぞれのリファレンスをご参照ください。

   

  • ・サンプル（物体検出＋一般物体認識）

    {
  "candidates": [
    {
      "score": 0.9588778018951416,
      "xMax": 239.06044006347656,
      "xMin": 133.04527282714844,
      "yMin": 61.752620697021484,
      "tag": "face",
      "yMax": 196.22528076171875,
      "secondAPIs": [
        {
          "candidates": [
            {
              "score": 0.8470529913902283,
              "tag": "cat"
            },
            {
              "score": 0.15294697880744934,
              "tag": "dog"
            }
          ],
          "jobId": "20210329144012215_GyuaThPcIp91Yh7boN2TitrDZVcQaBd8",
          "status": "success",
          "apiName": "classify"
        }
        ]
    }
  ],
  "jobId": "20210329144010227_1657?saveFlag=false",
  "status": "success",
  "detectJobId": "20210329144012095_42hXAW8iQ8bt0udvSwPJs2SUaD7y36Yv"
}