本文为您介绍SearchByPic的语法及示例,用于根据图片查询图像搜索实例中的图片信息。

SDK版本说明

图像SDK版本升级到V3.1.1,可使用“多主体识别”、“相似性分数”功能。请参见Java SDK

调试

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

请求参数

名称 类型 是否必选 示例值 描述
InstanceName String demoinstance1

图像搜索实例名称。

PicContent String xxxx

图片内容,Base64编码。

  • 图片大小要求不超过4 MB。
  • 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
  • 传输等待时间不超过5秒。
  • 服务类型为商品图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100且小于等于4096。
  • 服务类型为商标图片搜索时,图片长和宽像素要求大于等于200且小于4096。
  • 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448且小于等于4096。
  • 图片中不能包含旋转信息。
CategoryId Integer 88888888

商品类目。具体请参见类目参考

  • 对于商品搜索,如果设置类目,则以设置的为准;如果不设置类目,则由系统进行类目预测,预测的类目结果可以在Response中获取 。
  • 对于布料、商标、通用搜索,不论是否设置类目,系统会将类目设置为88888888。
Crop Boolean true

是否需要进行主体识别。默认true。

  • 为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。
  • 为false时,则不进行主体识别,以整张图进行搜索。
  • 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
Region String 280,486,232,351

图片的主体区域,格式为x1,x2,y1,y2, 其中x1,y1 是左上角的点,x2,y2是右下角的点。

说明
  • 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
  • 若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。
Num Integer 10

返回结果的数目。取值范围:1~100。默认值为10。

Start Integer 0

返回结果的起始位置。取值范围:0~499。默认值为0。

Filter String int_attr=1000 AND str_attr="value1"

过滤条件。int_attr支持的操作符有>、>=、<、<=、=。str_attr支持的操作符有=和!=,多个条件之支持AND和OR进行连接。例如:int_attr >= 100、str_attr != "value1"、int_attr = 1000 AND str_attr = "value1"。

返回数据

名称 类型 示例值 描述
Msg String success

错误信息。

Head object

搜索结果概述信息。

DocsFound Integer 10

返回结果数目。

DocsReturn Integer 10000

实例中命中结果数目。

SearchTime Integer 95

搜索耗时,单位毫秒。

RequestId String B3137727-7D6E-488C-BA21-0E034C38A879

请求ID。

Auctions Array of Auction

所有返回的商品描述信息。

PicName String 2092061_1.jpg

图片名称。

IntAttr Integer 2

整数类型属性。

CategoryId Integer 8888888

图片类目。

ProductId String 2092061_1

商品ID。

StrAttr String 2

字符串类型属性。

SortExprValues String 5.37633353624177e+24;0

系统打分信息。

说明
  • SortExprValues是一个分号分隔的二元组,第一个值表示图片的相关性分数,值越大表示和查询的图片相关性越高。由于算法模型不同。
  • 当类目为0~2时,SortExprValues值域范围为0, 7.33136443711219e+24
  • 类目为其他值时,SortExprValues值域范围为0,5.37633353624177e+24。当两个图片完全一样时,这个分值最大。
CustomContent String zidingyi

用户自定义的内容。

Score Float 1

图片相似打分。取值范围:0~1。

说明
  • 需要版本升级至V3.1.1方可使用。
Code Integer 0

错误码。

0:成功,

非0:失败。

PicInfo object

类目预测、主体识别结果等信息。

Region String 280,486,232,351

主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

CategoryId Integer 88888888

类目预测结果。若用户请求中指定了类目,则以请求中为准。

MultiRegion Array of reg

主体识别结果集合。

说明
  • 需要版本升级至V3.1.1方可使用。
Region String 88888888

主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

AllCategories Array of Category

系统支持的所有类目信息。

Name String other

类目名称。

Id Integer 88888888

类目ID。

Success Boolean ture

请求是否成功。

示例

请求示例

{
        "InstanceName": "demoinstance",
        "PicContent": "${Base64ImageContent}"
}

正常返回示例

JSON格式

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

{
  "Auctions" : [ {
    "CategoryId" : 0,
    "PicName" : "demo",
    "SortExprValues" : "7.33136443711219e+24;0",
    "Score" : 1.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
    } ],
    "MultiRegion" : [ {
      "Region" : "604,1814,451,1358"
    }, {
      "Region" : "843,1615,687,1138"
    } ]
  },
  "RequestId" : "D61D869E-E92A-447F-AD67-9234F999E516",
  "Msg" : "success",
  "Success" : true,
  "Code" : 0
}

错误码

请参见错误码