本文為您介紹SearchImageByName接口的語法及示例,用于根據名稱查詢圖像搜索實例中的圖片信息。
使用說明
本接口用于根據名稱(即ProductId和PicName)查詢圖像搜索實例中的圖片信息。
QPS限制
查詢操作默認的最大訪問頻率可在控制臺中查看,為您購買時所選擇的訪問頻次(QPS),當前支持1QPS、5QPS、10QPS。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | SearchImageByName | 系統規定參數。取值:SearchImageByName。 |
InstanceName | String | 是 | demoinstance1 | 圖搜實例名稱。最多支持20個字符。 如果已經購買圖搜實例可登錄圖像搜索管控臺查看。 說明 這里的實例名稱并非實例ID,使用時請區分。 |
ProductId | String | 是 | 2092061_1 | 商品ID。 |
PicName | String | 是 | 2092061_1.jpg | 圖片名稱。 |
CategoryId | Integer | 否 | 88888888 | 商品類目。具體請參見類目參考。
|
Num | Integer | 否 | 10 | 返回結果的數目。取值范圍:1~100。默認值為10。 |
Start | Integer | 否 | 0 | 返回結果的起始位置。取值范圍:0~499。默認值為0。 |
Filter | String | 否 | int_attr>=100 | 過濾條件。int_attr支持的操作符有大于號(>)、大于等于號(>=)、小于號(<)、小于等于號(<=)、等于號(=)。str_attr支持的操作符有等于號(=)和不等號(!=),多個條件之支持AND和OR進行連接。 例如:
說明 最多支持256個字符。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
Msg | String | success | 錯誤信息。 |
Head | Object | 搜索結果概述信息。 |
|
DocsFound | Integer | 10 | 返回結果數目。 |
DocsReturn | Integer | 10000 | 實例中命中結果數目。 |
SearchTime | Integer | 95 | 搜索耗時,單位毫秒。 |
RequestId | String | 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 | 請求ID。 |
Auctions | Array of Auction | 所有返回的商品描述信息。 |
|
ProductId | String | 2092061_1 | 商品ID。 |
PicName | String | 2092061_1.jpg | 圖片名稱。 |
CategoryId | Integer | 20 | 圖片類目。 |
SortExprValues | String | 5.37633353624177e+24;0 | 系統打分信息。 說明
|
CustomContent | String | zidingyi | 用戶自定義的內容。 |
Score | Float | 1 | 圖片相似打分。取值范圍:0~1。 說明 需要版本升級至V3.1.1方可使用。 |
IntAttr | Integer | 2 | 整數類型屬性。 |
IntAttr2 | Integer | 20 | 整數類型屬性。 |
StrAttr | String | ss | 字符串類型屬性。 說明 2023年1月3號之后創建的實例才能使用。 |
StrAttr2 | String | test | 字符串類型屬性。 說明 2023年1月3號之后創建的實例才能使用。 |
Code | Integer | 0 | 錯誤碼。
|
PicInfo | Object | 類目預測、主體識別結果等信息。 |
|
Region | String | 280,486,232,351 | 主體識別結果。 圖片的主體區域,格式為x1,x2,y1,y2,其中 x1,y1 是左上角的點,x2,y2是右下角的點。若用戶請求中指定了主體區域,則以請求中為準。 |
CategoryId | Integer | 20 | 類目預測結果。 若用戶請求中指定了類目,則以請求中為準。 |
MultiRegion | Array of reg | 主體識別集合。 |
|
Region | String | 280,486,232,351 | 主體識別結果。 圖片的主體區域,格式為x1,x2,y1,y2,其中 x1,y1 是左上角的點,x2,y2是右下角的點。若用戶請求中指定了主體區域,則以請求中為準。 |
AllCategories | Array of Category | 系統支持的所有類目信息。 |
|
Name | String | other | 類目名稱。 |
Id | Integer | 88888888 | 類目ID。 |
Success | Boolean | true | 請求是否成功。 |
示例
請求示例
{
"InstanceName": "demoinstance",
"ProductId": "ProductId",
"PicName”:“PicName"
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Auctions" : [ {
"CategoryId" : 0,
"PicName" : "demo",
"SortExprValues" : "7.33136443711219e+24;0",
"Score" : 1.0,
"ProductId" : "demo"
} ],
"Head" : {
"DocsReturn" : 1,
"DocsFound" : 1,
"SearchTime" : 155
},
"PicInfo" : {
"CategoryId" : 0,
"Region" : "111,697,113,774",
"AllCategories" : [ {
"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
} ],
"MultiRegion" : [ ]
},
"RequestId" : "D61D869E-E92A-447F-AD67-9234F999E516",
"Msg" : "success",
"Success" : true,
"Code" : 0
}
錯誤碼
請參見錯誤碼。