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

请求路径

协议 URL 方法 参数
HTTPS ${HOST}/v2/image/search POST JSON
${HOST}请参见请求结构

请求参数

名称 类型 是否必须 描述
InstanceName String 图像搜索实例名称。
Type String 搜索类型。包括:
  • SearchByPic(默认):根据图片搜索相似图片。
  • SearchByName:根据已添加的图片搜索相似图片。
PicContent String 图片内容,Base64编码。
  • 图片大小要求不超过4 MB。
  • 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
  • 传输等待时间不超过5秒。
  • 服务类型为商品图片搜索,商标图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100且小于等于4096。
  • 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448且小于等于4096。
  • 图片中不能包含旋转信息。
说明
  • Type=SearchByPic时该参数必填。
  • Type=SearchByName时无需填写,本参数不生效。
ProductId String - 商品ID。
说明
  • Type=SearchByPic无需填写,本参数不生效。
  • Type=SearchByName必填,已添加图片的ProductId。
PicName String - 图片名称。
说明
  • Type=SearchByPic时无需填写,本参数不生效。
  • Type=SearchByName时必填,已添加图片的PicName。
CategoryId Integer 商品类目。具体请参见类目参考
  • 对于商品搜索,如果设置类目,则以设置的为准;如果不设置类目,则由系统进行类目预测,预测的类目结果可以在Response中获取 。
  • 对于布料、商标、通用搜索,不论是否设置类目,系统会将类目设置为88888888。
说明
  • Type=SearchByPic时选填。
  • Type=SearchByName时无需填写,本参数不生效。
Crop Boolean 是否需要进行主体识别。默认true。
  • 为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。
  • 为false时,则不进行主体识别,以整张图进行搜索。
说明
  • Type=SearchByPic时选填。
  • Type=SearchByName时无需填写,本参数不生效。
  • 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
Region String 图片的主体区域,格式为x1,x2,y1,y2, 其中x1,y1 是左上角的点,x2,y2是右下角的点。
说明
  • 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
  • Type=SearchByPic时选填。若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。
  • Type=SearchByName时无需填写,本参数不生效。
Num Integer 返回结果的数目。取值范围:1~100。默认值为10。
Start Integer 返回结果的起始位置。取值范围:0~499。默认值为0。
Filter String 过滤条件。int_attr支持的操作符有>、>=、<、<=、=。str_attr支持的操作符有=和!=,多个条件之支持AND和OR进行连接。例如:int_attr>=100、str_attr!=”value1”、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 字符串类型属性。

示例

  • 请求示例
    URL: ${HOST}/v2/image/search
    POST Body:
     {
            "InstanceName": "demoinstance",
            "PicContent": "${Base64ImageContent}",
    }
  • 结果示例
    {
        "Auctions": [{
            "CategoryId": 0,
            "PicName": "demo",
            "SortExprValues": "7.33136443711219e+24;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
            }]
        },
        "RequestId": "D61D869E-E92A-447F-AD67-9234F999E516",
        "Msg": "success",
        "Success": true,
        "Code": 0
    }

错误码

请参见错误码