類似画像検索エンジン

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	画像ファイルのバイナリ	○
  numOfCandidates	実数
  threshold	実数
  apiRequestKey	実数	○

  • ・image
      分類する画像ファイルです。対応しているフォーマットはJPEG、png、bmp、gif、tiffです。
  • ・numOfCandidates
      返却候補件数を指定してください。
      指定しない場合、検索コンテナ起動時の設定内容を使用します。
      1以上の整数を入力してください。
  • ・threshold
      閾値処理をしたい場合は、指定してください。
      指定しない場合、検索コンテナ起動時の設定内容を使用します。
      設定範囲は、0.0～1.0です。
  • ・apiRequestKey
      0 を指定した場合、「指定した辞書(dictionaryId)から指定した画像(image)に近い画像のURL情報を取得する機能」を指定します。
      1 :を指定した場合、「指定した辞書(dictionaryId)から指定した画像(image)に近い画像のタグ情報を取得する機能」を指定します。
  • ・サンプル
    ------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="image"; filename="sample.png"
Content-Type: image/png
画像データ(binary)
------WebKitFormBoundaryhwZz6hhFHARN6wAB--
Content-Disposition: form-data; name="numOfCandidates"
5
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="threshold"
0.5
------WebKitFormBoundaryhwZz6hhFHARN6wAB
Content-Disposition: form-data; name="apiRequestKey"
0
------WebKitFormBoundaryhwZz6hhFHARN6wAB

• ・ボディ

  JSONキー	値	必須
  jobid	文字列	○
  status	文字列	○
  Candidates	object配列

  • ・jobid
      物体認識 API のプロトコルバージョン です。
  • ・status
      処理状態です。
      状態は以下の通りです。

    Status	意味
    success	成功
    failure	失敗

  • ・Candidates
      分類結果のcandidates objectをスコアの高い順にソートして配列で設定します。
  • ・candidates object
      必須:△については入力した apiRequestKey によっていずれかが返却されます。   

    JSONキー	値	必須
    dictionaryImageId	文字列	○
    score	実数	○
    imageUrl	文字列	△
    tag	文字列	△
    appendix	文字列	○

    • ・dictionaryImageId
        分類した画像のIDです
    • ・score
        分類した画像の精度を表します。値の範囲は-2147483648～2147483647です。
    • ・imageUrl
        類似画像のURLです。
    • ・tag
        類似画像のタグです。
    • ・appendix
        追加情報の文字列です。
   

  • ・サンプル

    {
  "jobid": "some-id-shown-here",
  "Status": "SUCCESS",
  "Candidates": [
    {
      "dictionaryImageId": "8",
      "Score": 57,
      "imageUrl": "http://url.to.image",
      "appendix": "some information",
    }
  ]
}