本接口用于向图像搜索实例中添加图片。

请求路径

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

请求参数

名称 类型 是否必须 描述
InstanceName String 图像搜索实例名称。
ProductId String 商品ID,最多支持512个字符。
说明 一个商品可以有多张图片。
PicName String 图片名称,最多支持512个字符。
说明
  • ProductId和PicName唯一确定一张图片。
  • 如果多次添加图片具有相同的ProductId和PicName,以最后一次添加为准,前面添加的图片将被覆盖。
PicContent String 图片内容,Base64编码。
  • 图片大小要求不超过4 MB。
  • 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
  • 传输等待时间不超过5秒。
  • 服务类型为商品图片搜索,商标图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100且小于等于4096。
  • 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448且小于等于4096。
  • 图片中不能包含旋转信息。
CategoryId Integer 图片类目。具体请参见类目参考
说明
  • 对于商品搜索,若设置类目,则以设置的为准;若不设置类目,将由系统进行类目预测,预测的类目结果可在Response中获取 。
  • 对于布料、商标、通用搜索,不论是否设置类目,系统会将类目设置为88888888。
Crop Boolean 是否需要进行主体识别。默认true。
  • 为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。
  • 为false时,则不进行主体识别,以整张图进行搜索。
说明 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
Region String 图片的主体区域,格式为x1,x2,y1,y2, 其中x1,y1 是左上角的点,x2,y2是右下角的点。
CustomContent String 用户自定义的内容,最多支持4096个字符。
说明 查询时会返回该字段。例如可添加图片的描述等文本。
IntAttr Integer 整数类型属性,可用于查询时过滤,查询时会返回该字段。
StrAttr String 字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。

返回参数

名称 类型 示例 描述
Success Boolean true 请求是否成功。
RequestId String 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1 请求ID。
Code Integer 0 错误码。0表示成功,非0表示失败。
Message String success 错误信息。
PicInfo - - 类目预测、主体识别结果。
└CategoryId Integer 88888888 类目预测结果。若用户请求中指定了类目,则以请求中为准。
└Region String 280,486,232,351 主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中x1,y1是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

示例

  • 请求示例
    URL: ${HOST}/v2/image/add
    POST Body:
     {
            "InstanceName": "demoinstance",
            "PicName": "test",
            "CustomContent": "demo content",
            "PicContent": "${Base64ImageContent}",
            "ProductId": "test",
            "IntAttr": "0",
            "StrAttr": "demo str attr"
        }
  • 结果示例
    {
        "PicInfo": {
            "Region": "111,697,XX,XX",
            "CategoryId": 0
        },
        "Message": "success",
        "RequestId": "B253A127-DF89-4DDC-A295-618DD22B00B2",
        "Success": true,
        "Code": 0
    }

错误码

请参见错误码