全部产品
云市场

新增图片

更新时间:2019-09-11 16:13:53

描述

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

请求路径

协议 URL 方法 参数
HTTPS ${HOST}/v2/image/add POST JSON

${HOST}参见请求结构

请求参数

名称 类型 是否必须 描述
InstanceName String 图像搜索实例名称。
ProductId String 商品id,最多支持 512个字符。
说明: 一个商品可有多张图片。
PicName String 图片名称,最多支持 512个字符。
说明:
1. ProductId + PicName唯一确定一张图片。
2. 如果多次添加图片具有相同的ProductId + PicName,以最后一次添加为准,前面添加的的图片将被覆盖。
PicContent String 图片内容,Base64编码。最多支持 2MB大小图片以及5s的传输等待时间。当前仅支持jpg和png格式图片;对于商品、商标、通用图片搜索,图片长和宽的像素必须都大于等于200,并且小于等于1024;对于布料搜索,图片长和宽的像素必须都大于等于448,并且小于等于1024;图像中不能带有旋转信息。
CategoryId Integer 图片类目。类目参考
说明:
1. 对于商品搜索:若设置类目,则以设置的为准;若不设置类目,将由系统进行类目预测,预测的类目结果可在Response中获取 。
2. 对于布料、商标、通用搜索:不论是否设置类目,系统会将类目设置为88888888。
Crop Boolean 是否需要进行主体识别,默认为true。
说明:
1.为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。
2. 为false时,则不进行主体识别,以整张图进行搜索。
3. 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
Region String 图片的主体区域,格式为 x1,x2,y1,y2, 其中 x1,y1 是左上角的点,x2,y2是右下角的点。
说明:
1.若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。
2. 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。
CustomContent String 用户自定义的内容,最多支持 4096个字符。
说明: 查询时会返回该字段。例如可添加图片的描述等文本。
IntAttr Integer 整数类型属性,可用于查询时过滤,查询时会返回该字段。
说明: 例如不同的站点的图片/不同用户的图片,可以设置不同的IntAttr,查询时通过过滤来达到隔离的目的
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是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

示例

请求示例

  1. URL: ${HOST}/v2/image/add
  2. POST Body:
  3. {
  4. "InstanceName": "demoinstance",
  5. "PicName": "test",
  6. "CustomContent": "demo content",
  7. "PicContent": "${Base64ImageContent}",
  8. "ProductId": "test",
  9. "IntAttr": "0",
  10. "StrAttr": "demo str attr"
  11. }

请求结果示例

  1. {
  2. "PicInfo": {
  3. "Region": "111,697,113,774",
  4. "CategoryId": 0
  5. },
  6. "Message": "success",
  7. "RequestId": "B253A127-DF89-4DDC-A295-618DD22B00B2",
  8. "Success": true,
  9. "Code": 0
  10. }

错误码

参见错误码章节