商品图片搜索
1. 描述
商品图片搜索接口,根据请求的图片,从已入库的图片中召回满足条件的图片。
图片及接口的通用信息说明,详见 服务概述
2. 接口地址
https://aiapi.jd.com/jdai/product_image_search
3. 请求方式
POST
4. 请求参数
(1) Query请求参数
公共请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
appkey |
string |
是 |
80d2b762ecb86593f9668526920f46c |
应用key,可在买家中心控制台中获取 |
timestamp |
long |
是 |
1541491668060 |
请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign |
string |
是 |
2e148773a0337a8f2200ba90d445f083 |
签名,根据规则MD5(secretkey+timestamp) |
业务请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
Content-Type |
string |
是 |
application/json |
请求内容类型 |
(3) Body请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
image_content |
string |
是 |
【略】 |
要搜索的图片内容,URL或Base64编码 |
collection_name |
string |
是 |
"服装商品库" |
指定搜索的商品库名称 |
category |
string |
否 |
"服装" |
搜索商品的类别【"服装"、"鞋靴"、"其他"】之一 |
topk |
int |
否 |
10 |
召回的图片数量,如不指定,默认50,最多200 |
5. 返回参数
(1) 公共返回参数
名称 |
类型 |
示例值 |
描述 |
code |
string |
1000 |
参见概述-系统级错误码 |
charge |
boolean |
false 或 true |
false:不扣费, true:扣费 |
remainTimes |
long |
1305 |
剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1 |
remainSeconds |
long |
1223456 |
剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1 |
msg |
string |
查询成功 |
参见概述-系统级错误码 |
result |
object |
{...} |
查询结果 |
(2) 业务返回参数
result参数说明
名称 |
类型 |
示例值 |
描述 |
code |
int |
0 |
参照概述-业务错误码 |
message |
string |
"SUCCESS" |
参照概述-业务错误信息 |
rectangle |
object |
{...} |
搜索商品图中商品的检测框坐标 |
images |
array |
[...] |
从图片库中召回的相似图片信息列表 |
rectangle 参数说明
名称 |
类型 |
示例值 |
描述 |
bottom |
float |
763.3587646484375 |
检测框最下边的纵坐标 |
top |
float |
40.80238342285156 |
检测框最上边的纵坐标 |
left |
float |
34.845638275146484 |
检测框最左边的横坐标 |
right |
float |
765.8860473632812 |
检测框最右边的横坐标 |
images 参数说明
名称 |
类型 |
示例值 |
描述 |
product_id |
string |
"65337027695" |
召回的图片所属商品的ID |
product_name |
string |
"女士风衣" |
召回的图片所属商品的名称 |
image_id |
string |
"1002039492343.jpg" |
召回的图片的唯一标识 |
similarity |
float |
0.98323532 |
召回的图片和搜索图片的相似度 |
image_info |
string |
【略】 |
召回的图片的额外描述信息 |
(3) 返回示例
{
"code": "10000",
"charge": false,
"remainTimes": 4998,
"remainSeconds": -1,
"msg": "查询成功",
"result": {
"code": 0,
"images": [
{
"image_id": "a0906237d2cd30ad.jpg",
"info": "",
"product_id": "102340326",
"product_name": "笔记本电脑",
"similarity": 0.49002131769384594
},
{
"image_id": "35e94ca3e9d9fdf9.jpg",
"info": "",
"product_id": "102340325",
"product_name": "电视",
"similarity": 0.22615687617595456
}
],
"message": "SUCCESS",
"rectangle": [
{
"bottom": 763.3587646484375,
"left": 34.845638275146484,
"right": 765.8860473632812,
"top": 40.80238342285156
}
]
}
}