edit-icon download-icon

画像の検索

最終更新日: May 24, 2019

説明

このインターフェイスは、Image Search インスタンス内の画像情報を検索するのに使用します。

リクエストパス

プロトコル URL 方法 パラメーター
HTTPS ${HOST}/v2/image/search POST JSON

${HOST} はリクエスト構造をご参照ください。

リクエストパラメーター

名前 必須 説明
InstanceName String はい Image Search インスタンス名
Type String いいえ 検索タイプ。選択肢:
1. SearchByPic(デフォルト):画像に基づいて類似画像を検索します。
2. SearchByName:追加した画像( ProductId と PicName で画像を特定)に基づいて類似画像を検索します。
PicContent String Base64 でエンコードした画像コンテンツ。最大 2 MB サイズの画像と 5 秒の送信待ち時間をサポートします。現在 jpg および png の画像形式のみサポートしています。縦と横の画素数は共に 200 以上 1024 以下でなければならず、画像に回転情報を含めることはできません。
説明:
1. Type=SearchByPic の場合、入力する必要があります。
2. Type=SearchByName の場合、入力する必要はなく、このパラメーターは無効になります。
ProductId String 商品 ID
説明:
1. Type = SearchByPic の場合、入力する必要はなく、このパラメーターは無効になります。
2. Type=SearchByName の場合、追加済みの画像の ProductId を入力する必要があります。
PicName String 画像名。
説明:
1. Type = SearchByPic の場合、入力する必要はなく、このパラメーターは無効になります。
2. Type = SearchByPic の場合、追加済みの画像の PicName を入力する必要があります。
CategoryId Integer いいえ 商品カテゴリ。カテゴリの参照
説明:
1. Type=SearchByPic の場合、入力は任意です。1)商品画像検索の場合:カテゴリが設定されている場合はその設定が優先され、設定されていない場合はシステムがカテゴリ予測を実行し、予測されたカテゴリの結果を Response で取得できます。2)一般画像検索の場合:カテゴリが設定されているかどうかに関わらず、システムによりカテゴリが 88888888 に設定されます。
2. Type=SearchByName の場合、入力する必要はなく、このパラメーターは無効になります。
Crop Boolean いいえ 被写体認識の要否。デフォルトは true です。
説明:
1.Type=SearchByPic の場合、入力は任意です。1)true の場合、システムにより被写体認識が行われ、認識された被写体による検索が実行されます。被写体認識結果を Response で取得できます。2)false の場合、被写体は認識されず、画像全体として検索されます。
2. Type=SearchByName の場合、入力する必要はなく、このパラメーターは無効になります。
Region String いいえ x1、x2、y1、y2 の形式で表される画像の被写体範囲。x1、y1 は左上の点、x2、y2 は右下の点です。
説明:
1. Type=SearchByPic の場合、入力は任意です。ユーザーが Region を設定した場合、Crop パラメーターの値に関わらず、その Region で検索を実行します。
2. Type=SearchByName の場合、入力する必要はなく、このパラメーターは無効になります。
Num Integer いいえ 戻り値の数。有効範囲:1〜100、デフォルト:10
Start Integer いいえ 戻り値の開始位置。有効範囲:0〜499、デフォルト:0
Filter String いいえ フィルター条件。
説明: int_attr でサポートされている演算子は >、>=、<、<=、=、str_attr でサポートされている演算子は = と != で、複数条件は AND と OR で接続します。
例:
1. IntAttr で結果をフィルタリングする場合、int_attr>=100
2. StrAttr で結果をフィルタリングする場合、str_attr!=”value1”
3. IntAttr と StrAttr を組み合わせて結果をフィルタリングする場合、int_attr=1000 AND str_attr=”value1”

リターンパラメーター

名前 説明
Success Boolean true リクエストの成功是非
RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 リクエスト ID
Code Integer 0 エラーコード。0 は成功、0 以外は失敗を意味します。
Message String success エラーメッセージ
Head 検索結果の概要情報
└ DocsReturn Integer 10 戻り値の数。
└ DocsFound Integer 10000 インスタンス内のヒット数。
└ SearchTime Integer 95 検索時間。単位はミリ秒です。
PicInfo カテゴリ予測、被写体認識結果などの情報。
└ CategoryId Integer 88888888 カテゴリ予測結果。カテゴリがユーザーのリクエストで指定されている場合は、その指定が優先されます。
└ Region String 280,486,232,351 被写体認識結果。x1、x2、y1、y2 の形式で表される画像の被写体範囲。x1、y1 は左上の点、x2、y2 は右下の点です。被写体範囲がユーザーのリクエストで指定されている場合は、その指定が優先されます。
└ AllCategories システムでサポートされているすべてのカテゴリ情報
└ Name String Tops カテゴリ名
└ Id Integer 0 カテゴリ ID
Auctions すべての返される商品説明情報
└ CustomContent String Demo Custom Content ユーザーがカスタマイズした内容
└ PicName String DemoPic 画像名
└ CategoryId Integer 0 画像カテゴリ
└ ProductId String test 商品 ID
└ SortExprValues String 7.33136443711219e+24;0 システムのスコア付け情報。
説明: SortExprValues はセミコロンで区切られた 2 つの値で表されます。1 つ目の値は画像の関連性スコアを表し、値が大きいほど検索画像との相関が高くなります。アルゴリズムモデルが異なるため、SortExprValues の範囲は、カテゴリが 0〜2 の場合 [0, 7.33136443711219e+24]、その他の値の場合 [0,5.37633353624177e+24] になります。2 つの画像が同一の場合、スコアは最大になります。2 つ目の値は画像特徴ベクトルのハミング距離を表し、値が大きいほど類似度は低くなります。現在、1 つ目の値を基準にソートされているため、ユーザーは 1 つ目の値に見ればよく、2 つの画像が類似しているかどうかを判断するための明確なしきい値はありません。
└ IntAttr Integer 0 整数型の属性
└ StrAttr String demoStrAttr 文字列型の属性

リクエスト例

  1. URL: ${HOST}/v2/image/search
  2. POST Body:
  3. {
  4. "InstanceName": "demoinstance",
  5. "PicContent": "${Base64ImageContent}",
  6. }

リクエスト結果例

  1. {
  2. "Auctions": [{
  3. "CategoryId": 0,
  4. "PicName": "demo",
  5. "SortExprValues": "7.33136443711219e+24;0",
  6. "ProductId": "demo"
  7. }],
  8. "Head": {
  9. "DocsReturn": 1,
  10. "DocsFound": 1,
  11. "SearchTime": 155
  12. },
  13. "PicInfo": {
  14. "CategoryId": 0,
  15. "Region": "111,697,113,774",
  16. "AllCategories": [{
  17. "Name": "Tops",
  18. "Id": 0
  19. }, {
  20. "Name": "Dress",
  21. "Id": 1
  22. }, {
  23. "Name": "Bottoms",
  24. "Id": 2
  25. }, {
  26. "Name": "Bag",
  27. "Id": 3
  28. }, {
  29. "Name": "Shoes",
  30. "Id": 4
  31. }, {
  32. "Name": "Accessories",
  33. "Id": 5
  34. }, {
  35. "Name": "Snack",
  36. "Id": 6
  37. }, {
  38. "Name": "Makeup",
  39. "Id": 7
  40. }, {
  41. "Name": "Bottle",
  42. "Id": 8
  43. }, {
  44. "Name": "Furniture",
  45. "Id": 9
  46. }, {
  47. "Name": "Toy",
  48. "Id": 20
  49. }, {
  50. "Name": "Underwear",
  51. "Id": 21
  52. }, {
  53. "Name": "Digital device",
  54. "Id": 22
  55. }, {
  56. "Name": "Other",
  57. "Id": 88888888
  58. }]
  59. },
  60. "RequestId": "D61D869E-E92A-447F-AD67-9234F999E516",
  61. "Msg": "success",
  62. "Success": true,
  63. "Code": 0
  64. }

エラーコード

エラーコードをご参照ください。