新增图片

更新时间:2024-09-10 02:43:57

本文为您介绍AddImage接口的语法及示例,用于向图像搜索实例中添加图片信息。

使用说明

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

QPS限制

10W图片容量的实例默认的并发量为1,也就是每秒钟最多处理1个图片新增请求。

其他图片容量的实例默认的并发量为5,也就是每秒钟最多处理5个图片新增请求。

调试

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

调试

请求参数

名称

类型

是否必选

示例值

描述

名称

类型

是否必选

示例值

描述

Action String AddImage

系统规定参数。取值:AddImage。

InstanceName String demoinstance1

图搜实例名称。最多支持20个字符。

如果已经购买图搜实例可登录图像搜索管控台查看。

如果没有购买图搜实例可参考开通服务创建实例

说明
这里的实例名称并非实例ID,使用时请区分。
ProductId String 2092061_1

商品ID,最多支持512个字符。

说明
一个商品可以有多张图片。
PicName String 2092061_1.jpg

图片名称,最多支持512个字符。

说明
  • ProductId和PicName唯一确定一张图片。
  • 如果多次添加图片具有相同的ProductId和PicName,以最后一次添加为准,前面添加的图片将被覆盖。
PicContent String AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=

图片内容。

  • 图片大小要求不超过4 MB。
  • 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
  • 传输等待时间不超过5秒。

  • 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。
  • 服务类型为商标图片搜索时,图片长和宽像素要求大于等于200PX且小于4096PX。
  • 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448PX且小于等于4096PX。

  • 图片中不能包含旋转信息。
说明
  • 使用SDK方式调用:
    • 如使用V3版本SDK,则无需填写PicContent字段,SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考JAVA SDK
    • SDK不支持客户直接传递图片URL,V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考JAVA SDK
  • 使用阿里云OpenAPI平台调用:
    • 如使用2019-03-25版本,PicContent字段请填写图片的Base64编码。
    • 如使用2020-12-14版本,在PicContent字段直接点击上传图片即可。
CategoryId Integer 88888888

图片类目。具体请参考类目参考

说明
  • 对于商品搜索,若设置类目,则以设置的为准;若不设置类目,将由系统进行类目预测,预测的类目结果可在Response中获取 。

  • 对于布料、商标、通用、家具家居和工业五金搜索,不论是否设置类目,系统会将类目设置为88888888。

  • 对于通用搜索,不论是否设置类目,系统会将类目设置为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进行搜索。

  • 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。

  • Region参数没有单位,是参考使用图片的长宽PX像素尺寸标记的结果,如果图片缩放对应Region参数值也要等比例缩放。
CustomContent String zidingyi

用户自定义的内容,最多支持4096个字符。

说明
查询时会返回该字段。例如可添加图片的描述等文本。
IntAttr Integer 22

整数类型属性,可用于查询时过滤,查询时会返回该字段。

StrAttr String ss

字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。

说明
不支持特殊字符比如:\¥$&%
IntAttr2 Integer 22

整数类型属性,可用于查询时过滤,查询时会返回该字段。

说明
2023年1月3号之后创建的实例才能使用。
StrAttr2 String ss

字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。

说明
  • 不支持特殊字符比如:\¥$&%
  • 2023年1月3号之后创建的实例才能使用。

返回数据

名称

类型

示例值

描述

名称

类型

示例值

描述

Message String success

错误信息。

说明
成功请求不返回数据,失败请求返回错误信息。
RequestId String E0845DE6-52AF-4B50-9F15-51ED4044E6AB

请求ID。

Code Integer 0

错误码。

  • 0:成功。
  • 非0:失败。
PicInfo Object

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

Region String 94,691,206,650

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

CategoryId Integer 88888888

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

Success Boolean true

请求是否成功。

示例

请求示例

{
        "InstanceName": "demoinstance",
        "PicName": "test",
        "CustomContent": "demo content",
        "PicContent": "${Base64ImageContent}",
        "ProductId": "test",
        "IntAttr": "0",
        "StrAttr": "demo str attr"
    }

正常返回示例

JSON格式

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

{
  "PicInfo" : {
    "Region" : "111,697,XX,XX",
    "CategoryId" : 0
  },
  "Message" : "success",
  "RequestId" : "B253A127-DF89-4DDC-A295-618DD22B00B2",
  "Success" : true,
  "Code" : 0
}

错误码

请参见错误码

  • 本页导读 (1)
  • 使用说明
  • QPS限制
  • 调试
  • 请求参数
  • 返回数据
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

阿里云 AI 助理已上线!

快来体验一下吧。