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

调用本接口时需要在Url参数中传入instanceName参数,表示要查询的实例,其它参数拼接成系统指定的格式串,然后通过Body进行传输。请求路径为/item/search

请求参数

  • URL中参数
    名称 类型 是否必须 描述
    instanceName String 查询实例名称。
  • Body中参数
    名称 类型 是否必须 描述
    cat_id String 类目ID。
    n int 返回结果的数目。
    s int 返回结果的起始位置。
    crop boolean 是否需要进行主体识别,默认为true。
    region String 图片的主体区域,格式为x1,x2,y1,y2,其中x1,y1是左上角的点,x2,y2是右下角的点,默认自动识别主体区域。
    pic_list List 搜索的图片名称,只能指定1个。
    pic_map Map 搜索图片对应的内容。
  • Body构造方法
    Body的格式如下:
    key1,key1_start_offset,key1_end_offset#...#keyn,keyn_start_offset,keyn_end_offset^key1_content...keyn_content

    整体来看body可以分成两个部分。^前面表示Meta部分,^后面表示Content部分。Meta部分描述有哪些Key ,以及每个Key对应值在 Content中的偏移。多个Key之间用井号(#)分隔,单个Key内部用英文逗号(,)分隔。Key后面的两个数字分别表示Key在Content中的起始位置和结束位置。此外,对于pic_list中每个图片名称需要进行base64编码。多个图片名称之间用逗号拼接成一个字符串。pic_map中每一个key和pic_list中的对应,并且pic_map中的图片内容也需要进行base64编码。

返回参数

名称 类型 描述
Success Boolean 请求是否成功。
RequestId String 请求ID。
Code int 错误码。0表示成功,非0表示失败。
Message String 错误信息。
Head Map 结果描述信息。
DocsReturn int 返回结果数目。
DocsFound int 实例中命中结果数目。
PicInfo Map 抠图相关信息。
Category String 图片所属的类目。
Region String 图片的主体区域,格式为x1,x2,y1,y2,其中x1,y1是左上角的点,x2,y2是右下角的点,默认自动识别主体区域。
AllCategory Map 系统支持的所有类目信息。
Name String 类目名称。
Id String 类目ID。
Auctions Map 表示所有返回的商品描述信息。
CustContent String 表示商品自定义的信息。
PicName String 图片名称。
CatId String 图片类目。
ProductId String 商品ID。
SortExprValues String 系统打分信息。

返回格式

{
    "Auctions": {
        "Auction": [{
            "CustContent": "k1:v1,k2:v2,k3:v3",
            "PicName": "girl_cloth3.jpg",
            "CatId": "0",
            "SortExprValues": "7.33136443711219e+24;0",
            "ProductId": "1002"
        }]
    },
    "Head": {
        "DocsReturn": 1,
        "DocsFound": 57,
        "SearchTime": 124
    },
    "PicInfo": {
        "Category": "0",
        "Region": "51,339,91,392",
        "AllCategory": {
            "Category": [{
                "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"
            }]
        }
    },
    "Message": "success",
    "RequestId": "183A7C57-20B9-4AE6-8227-1EE8B0A4B99B",
    "Success": true,
    "Code": 0
}

示例

假定某个用户要搜索实例goodssearch中类目为0下的某一个商品。图片内容为pic_content1,图片名称可任意指定,本例为searchPic,返回结果的起始位置为0,返回结果的数目为10。最终请求方式如下:
URL: /item/search?instaneName=goodssearch
POST Body:
s,0,1#cat_id,1,2#pic_list,2,14#c2VhcmNoUGlj,14,30#n,30,32^00c2VhcmNoUGljcGljX2NvbnRlbnQx10
说明 其中c2VhcmNoUGlj表示searchPic进行base64编码后的值。