全部产品
云市场

查询图片

更新时间:2019-09-11 16:10:28

描述

本接口用于查询图像搜索实例中的图片信息。

请求路径

协议 URL 方法 参数
HTTPS ${HOST}/v2/image/search POST JSON

${HOST}参见请求结构

请求参数

名称 类型 是否必须 描述
InstanceName String 图像搜索实例名称。
Type String 搜索类型,取值范围:
1. SearchByPic(默认):根据图片搜索相似图片。
2. SearchByName,根据已添加的图片搜索相似图片。
PicContent String 图片内容,Base64编码。最多支持 2MB大小图片以及5s的传输等待时间。当前仅支持jpg和png格式图片;对于商品、商标、通用图片搜索,图片长和宽的像素必须都大于等于200,并且小于等于1024;对于布料搜索,图片长和宽的像素必须都大于等于448,并且小于等于1024;图像中不能带有旋转信息。
说明:
1. Type=SearchByPic时,必填。
2. Type=SearchByName时,无需填写,本参数不生效。
ProductId String 商品id。
说明:
1. Type=SearchByPic时,无需填写,本参数不生效。
2. Type=SearchByName时,必填,已添加图片的ProductId。
PicName String 图片名称。
说明:
1. Type=SearchByPic时,无需填写,本参数不生效。
2. Type=SearchByName时,必填,已添加图片的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时,无需填写,本参数不生效。
3. 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
Region String 图片的主体区域,格式为 x1,x2,y1,y2, 其中 x1,y1 是左上角的点,x2,y2是右下角的点。
说明:
1. Type=SearchByPic时,选填:若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。
2. Type=SearchByName时,无需填写,本参数不生效。
3. 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
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是一个分号分隔的二元组,第一个值表示图片的相关性分数,值越大表示和查询的图片相关性越高。由于算法模型不同,当类目为0-2时,SortExprValues值域范围为[0, 7.33136443711219e+24];类目为其他值时,SortExprValues值域范围为[0,5.37633353624177e+24]。当两个图片完全一样时,这个分值最大;第二个值表示图片特征向量的海明距离,值越大相似度越低。目前排序都是根据第一个值,因此用户只需要关注第一个值即可,目前暂时没有一个明确的阈值,用来判断两个图片相似还是不相似。
└ 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. }

错误码

参见错误码章节