图片搜索请求
图片搜索请求用于搜索指定库中是否存在相同、相似的图片。
图片及接口的通用说明详见 服务概述
1). 接口地址
https://aiapi.jd.com/jdai/index_search
2). 请求方式
post
3). 接口数据要求
见概述
4). 请求参数
(1) query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | string | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获取 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | string | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
(2) header请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | string | 是 | application/x-www-form-urlencoded | 编码格式 |
(3) body请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
collection_name | string | 是 | "food" | 库名 |
query_content | string | 是 | 图像Base64编码值,去掉图片头"data:image/png;base64,",query_content=iVBORw0K...(由于过长,不给出示例) | 图片base64编码 |
top_k | int | 否 | 50 | 召回数量,默认50,最大200 |
返回参数
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参数信息
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
status_code | int | 0 | 参照概述-业务错误码 |
message | string | "Interface" | 参照概述-业务错误信息 |
search_result | array | [...] | 搜索结果 |
search_result参数信息
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
image_name | string | "Milk_salt_soda_v1" | 召回图片所属集合id,入库时提供 |
similarity | double | 0.92323356 | 召回图片和请求图的相似度;当为1时,即两张图为完全一样的图片; |
info | string | "{\"Ingredients\":\"wheat flour, milkfat, edible salt\", \"price\":\"10.0\"}" | 召回图片所带json信息,仅在入库时附带了此信息时返回 |
3). 返回示例
Status Code: 200
Time:746ms
Date:Fri 15 Mar 2019 08:20:38 GMT
Body:
{
"code": "10000",
"charge": false,
"remainTimes": 4998,
"remainSeconds": -1,
"msg": "查询成功",
"result": {
"status_code":0,
"message":"SUCCESS",
"search_result":[
{
"image_name":"Milk_salt_soda_v1",
"similarity":0.92323356,
"info ":'{"Ingredients":"wheat flour, milkfat, edible salt", "price":"10.0"}'
},
……
]
}
}