Image Search インスタンスで画像情報を検索します。
この操作を呼び出す前に、URL で instanceName パラメーターを指定して、画像を検索するインスタンスを指定する必要があります。 他のパラメーターも指定の形式で設定してリクエスト本文を作成する必要があります。 リクエスト URL には /item/search が含まれます。
リクエストパラメーター
- URL のパラメーター
パラメーター データ型 必須/任意 説明 instanceName String 必須 画像を検索するインスタンスの名前です。 - リクエスト本文のパラメーター
パラメーター データ型 必須/任意 説明 cat_id String 任意 カテゴリの ID です。 n int 任意 返される画像の数です。 s int 任意 最初に表示される画像の数です。 crop Boolean 任意 画像内の被写体を認識し、認識されたた被写体に基づいて画像を検索するかどうかを指定します。 有効な値: true と false。 デフォルト値: true。 region String 任意 画像のサブジェクトエリアです。 サブジェクトエリアは次の形式です: x1,x2,y1,y2
。x1 and y1
は左上隅のピクセルを表します。x2 and y2
は右下のピクセルを表します。 デフォルトでは、サブジェクトエリアが自動的に認識されます。pic_list List 必須 類似画像の検索に使用されるサンプル画像の名前です。 画像名は 1 つのみ指定できます。 pic_map Map 必須 サンプル画像の内容です。 - 本文の構造
本文の形式は以下のとおりです。
key1,key1_start_offset,key1_end_offset#...#keyn,keyn_start_offset,keyn_end_offset^key1_content...keyn_content
本文は、画像メタデータと画像コンテンツの 2 つの部分に分かれており、曲折アクセント記号 (^) で区切られます。 メタデータには、キーのセットとコンテンツ内の各キー値のオフセットが含まれます。 すべてのキーは、番号記号 (#) で区切られます。 各キーは、キー名、開始オフセット値および終了オフセット値からなり、コンマ (,)で区切られます。 開始オフセット値および終了オフセット値は、画像コンテンツにおけるキーの開始位置および終了位置です。 pic_list パラメーターには、Base64 でエンコードされた画像名をコンマ (,) で区切って指定します。 pic_map パラメーターには 、Base64 でエンコードされた画像コンテンツを指定します。 pic_map パラメーターで指定された各キーは、pic_list パラメーターで指定されたキーとペアにする必要があります。
レスポンスパラメーター
パラメーター | データ型 | 説明 |
---|---|---|
Success | Boolean | 呼び出しが成功したかどうかを示します。 |
RequestId | String | リクエストの ID です。 |
Code | int | エラーコードです。 値が 0 の場合、リクエストが成功したことを示します。 値が 0 以外の場合、リクエストが失敗したことを示します。 |
Message | String | 返されたメッセージです。 |
Head | Map | 検索結果の説明です。 |
DocsReturn | int | 返された画像の数を示します。 |
DocsFound | int | インスタンス内の該当ノードの数です。 |
PicInfo | Map | 画像のマット情報です。 |
Category | String | 画像のカテゴリです。 |
Region | String | 画像のサブジェクトエリアです。 サブジェクトエリアは次の形式です:x1,x2,y1,y2 。x1 and y1 は左上隅のピクセルを表します。x2 and y2 は右下のピクセルを表します。 デフォルトでは、サブジェクトエリアが自動的に認識されます。
|
AllCategory | Map | システムでサポートされているすべてのカテゴリです。 |
Name | String | カテゴリの名前です。 |
Id | String | カテゴリの ID です。 |
Auctions | Map | 返されたすべてのプロダクトの説明です。 |
CustContent | String | プロダクトのカスタムコンテンツです。 |
PicName | String | 画像の名前です。 |
CatId | String | 画像のカテゴリです。 |
ProductId | String | プロダクトの ID です。 |
SortExprValues | String | 画像に関するスコア情報です。 |
レスポンスフォーマット
{
"Auctions": {
"Auction": [{
"CustContent": "k1:v1,k2:v2,k3:v3",
"PicName": "girl_cloth3.jpg",
"CatId": "0",
"SortExprValues": "7.33136443711219e+24;0",
"ProductId": "1002"
}]
},
"Head": {
"DocsReturn": 1,
"DocsFound": 57,
"SearchTime": 124
},
"PicInfo": {
"Category": "0",
"Region": "51,339,91,392",
"AllCategory": {
"Category": [{
"Name": "Tops",
"Id": "0"
}, {
"Name": "Dress",
"Id": "1"
}, {
"Name": "Bottoms",
"Id": "2"
}, {
"Name": "Bag",
"Id": "3"
}, {
"Name": "Shoes",
"Id": "4"
}, {
"Name": "Accessories",
"Id": "5"
}, {
"Name": "Snack",
"Id": "6"
}, {
"Name": "Makeup",
"Id": "7"
}, {
"Name": "Bottle",
"Id": "8"
}, {
"Name": "Furniture",
"Id": "9"
}, {
"Name": "Toy",
"Id": "20"
}, {
"Name": "Underwear",
"Id": "21"
}, {
"Name": "Digital device",
"Id": "22"
}, {
"Name": "Other",
"Id": "88888888"
}]
}
},
"Message": "success",
"RequestId": "183A7C57-20B9-4AE6-8227-1EE8B0A4B99B",
"Success": true,
"Code": 0
}
例
次の例は、goodssearch インスタンスでカテゴリ ID が 0 の商品画像を検索する方法を示します。 この例では、画像コンテンツは pic_content1、画像名は
searchPic です。 最初に表示される画像の数は 0 です。 返される画像の数は 10 です。 次のリクエストが提供されます。
URL: /item/search? instaneName=goodssearch
POST Body:
s,0,1#cat_id,1,2#pic_list,2,14#c2VhcmNoUGlj,14,30#n,30,32^00c2VhcmNoUGljcGljX2NvbnRlbnQx10
注 注意:c2VhcmNoUGlj は Base64 エンコードされた画像名を表します。