调用SearchByPic接口实现淘宝联盟以图搜商品-图像搜索-阿里云

使用说明

本接口用于向淘宝联盟版在线调用。

QPS限制

查询操作默认5QPS。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	SearchByPic	系统规定参数。取值：SearchByPic。
PicContent	String	是	xxx	图片内容。图片大小要求不超过4 MB。图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。传输等待时间不超过5秒。图片中不能包含旋转信息。说明如使用SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段无需处理。
CategoryId	Integer	否	88888888	图片类目。具体请参考类目参考。说明如果设置类目，则以设置的为准；如果不设置类目，则由系统进行类目预测，预测的类目结果可以在Response中获取。
Pid	String	否	mm_xxx_xxx_xxx	PID。具体请参考PID。说明使用V1.1.0及以上版本的SDK可用该字段。
UserType	Long	否	0	卖家类型。 1：天猫， 0：淘宝。
Crop	Boolean	否	true	是否需要进行主体识别。默认true。为true时，由系统进行主体识别。建议使用此方式。为false时，则不进行主体识别，以整张图进行搜索。
Region	String	否	280,486,232,351	图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1` 是左上角的点，`x2,y2`是右下角的点。说明若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。
Start	Integer	否	0	返回结果的起始位置。取值范围：0~499。默认值为0。
Num	Integer	否	10	返回结果的数目。取值范围：1~20。默认值为10。
Fields	String	否	Url,UserType	需要返回的字段list。不同的字段用逗号分割。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。
RelationId	Long	否	1125526	渠道ID。用于淘宝联盟中的渠道区分。

返回数据

名称	类型	示例值	描述
Success	Boolean	true	请求是否成功。
Code	Integer	0	错误码。 0：成功，非0：失败。
Message	String	sucess	错误信息。
Data	Object		识别结果集合。
Auctions	Array of auction		识别结果。
Result	Object		查询结果。
ItemId	String	casdcascascasc-dsasdasdasdasdas	商品信息-商品ID。
Title	String	xxx套装	商品信息-商品标题。
ShortTitle	String	yyy套装	商品信息-商品短标题（移动端建议使用）。
SubTitle	String	xxx套装	商品信息-商品子标题。
PicUrl	String	//img.alicdn.com/i1/FXXXXXXXXXX.jpg	商品信息-商品主图。
ReservePrice	String	158	商品信息-一口价通常显示为划线价。
ZkFinalPrice	String	98	商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。
PriceAfterCoupon	String	90	商品信息-券后价。
UserType	Integer	0	店铺信息-卖家类型。 1：天猫， 0：淘宝。
Provcity	String	广东深圳	商品信息-宝贝所在地。
Nick	String	衣服专卖店	店铺信息-卖家昵称。
SellerId	String	32590610	店铺信息-卖家ID。
Volume	Integer	500	商品信息-30天销量。
LevelOneCategoryName	String	童装/婴儿装/亲子装	商品信息-叶子类目名称。
CategoryName	String	连衣裙	商品信息-一级类目名称。
CouponTotalCount	String	100000	优惠券信息-优惠券总量。
CouponRemainCount	Integer	0	优惠券信息-优惠券剩余量。
CouponStartTime	String	2021-05-01	优惠券信息-优惠券开始时间。
CouponEndTime	String	2021-06-01	优惠券信息-优惠券结束时间。
CouponStartFee	String	98.000000	优惠券信息-优惠券启用门槛，满X元可用。如：满299元减20元。
CouponAmount	Integer	5	优惠券（元）若属于预售商品，该优惠券付尾款可用，付定金不可用。
CouponInfo	String	满98.0元减5.0元	优惠券信息-优惠券满减信息。
CommissionRate	String	180	商品信息-佣金比率。如：1550表示15.5%。
CouponShareUrl	String	//uland.taobao.com/xxxxxxx	链接-宝贝+券二合一页面链接。
DeeplinkCouponShareUrl	String	tbopen://m.taobao.com/tbopen/index.html?	优惠券-手淘唤醒链接。
Url	String	//s.click.taobao.com/t?xxxxxx	链接-宝贝推广链接。
DeeplinkUrl	String	tbopen://m.taobao.com/tbopen/index.html?	链接-宝贝推广的深度唤醒链接。
ShopTitle	String	xx旗舰店	店铺信息-店铺名称。
MaxCommission	Object		商品信息-高佣信息。
MaxCommissionRate	String	20.4	商品信息-最优佣金率。如：20.4表示佣金率为20.4%。
MaxCommissionClickUrl	String	https://s.click.taobao.com/t?e=xxxx	商品信息-链接-最优佣金率宝贝推广链接。
MaxCommissionCouponShareUrl	String	https://uland.taobao.com/coupon/xxxx	商品信息-链接-最优佣金率宝贝+券二合一页面链接。
RankScore	Float	0.337	商品相似性的排名分数。取值范围：0~1。
RequestId	String	B3137727-7D6E-488C-BA21-0E034C38A879	请求ID。
PicInfo	Object		类目预测、主体识别结果等信息。
MainRegion	Object		主体多类目信息。
Region	String	280,486,232,351	主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。
MultiCategoryId	Array of cate		主体预测区域的类目预测结果集合。
CategoryId	Integer	88888888	图片类目。具体请参考类目参考。
Score	Float	0.34	预测的类目得分。取值范围：0~1。
MultiRegion	Array of reg		主体识别结果集合。
Region	String	280,486,232,351	主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。

示例

请求示例

{
        "picContent": "${Base64ImageContent}",
         "pid":"mm_xxx_xxx_xxx"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : 0,
  "data" : {
    "auctions" : [ {
      "rankScore" : 0.9877,
      "result" : {
        "itemId" : "22222",
        "shortTitle" : "xxx套装",
        "subTitle" : "xxx套装",
        "categoryName" : "USB风扇",
        "commissionRate" : "90",
        "couponAmount" : 2,
        "couponEndTime" : "2021-08-31",
        "couponInfo" : "满15.0元减2.0元",
        "couponRemainCount" : 72287,
        "couponShareUrl" : "//uland.taobao.com/coupon/edetail?xxx",
        "couponStartFee" : "15.000000",
        "couponStartTime" : "2021-07-06",
        "couponTotalCount" : "100000",
        "levelOneCategoryName" : "3C数码配件",
        "maxCommission" : {
          "maxCommissionClickUrl" : "https://s.click.taobao.com/txxxx",
          "maxCommissionCouponShareUrl" : "https://uland.taobao.com/xxxxx",
          "maxCommissionRate" : "0.90"
        },
        "nick" : "urkazf旗舰店",
        "picUrl" : "//img.alicdn.com/pic.jpg",
        "provcity" : "广东 深圳",
        "reservePrice" : "65.8",
        "sellerId" : "2207366944297",
        "shopTitle" : "urkazf旗舰店",
        "title" : "【官方推荐】电风扇",
        "url" : "//s.click.taobao.com/t?xxx",
        "userType" : 1,
        "volume" : 12515,
        "zkFinalPrice" : "15.8",
        "priceAfterCoupon" : "12.8",
        "DeeplinkUrl" : "tbopen://m.taobao.com/tbopen/index.html?",
        "DeeplinkCouponShareUrl" : "tbopen://m.taobao.com/tbopen/index.html?"
      }
    } ]
  },
  "picInfo" : {
    "mainRegion" : {
      "multiCategoryId" : [ {
        "categoryId" : 88888888,
        "score" : 0.79521
      }, {
        "categoryId" : 22,
        "score" : 0.13365
      }, {
        "categoryId" : 9,
        "score" : 0.00778
      }, {
        "categoryId" : 7,
        "score" : 0.00685
      } ],
      "region" : "428,750,64,739"
    },
    "multiRegion" : [ {
      "region" : "428,750,64,739"
    }, {
      "region" : "428,750,64,739"
    } ]
  },
  "requestId" : "xx-FDF7-xxx-A794-xxx",
  "success" : true
}

错误码

请参见错误码。