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

调试

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

请求参数

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

图搜实例名称。

ProductId String 2092061_1

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

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

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

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

图片内容,Base64编码。

  • 图片大小要求不超过4 MB。
  • 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。
  • 传输等待时间不超过5秒。
  • 服务类型为商品图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100且小于等于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是右下角的点。

CustomContent String zidingyi

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

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

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

StrAttr String ss

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

返回数据

名称 类型 示例值 描述
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
}

错误码

HttpCode 错误码 错误信息 描述
400 BadRequest The request has invalid parameters. 无效的参数
400 InstanceStatusError Your instance is unavailable. 实例状态不可用
400 InvalidInstance The specified instance name is invalid. 实例名错误
400 NoCaretSeperator The body content is missing the ^ separator. 请求body缺少特定符号
400 EmptyMeta The body content has an empty meta field. 请求body含有空的字段
400 InvalidMetaItem The meta field is invalid. 无效的元信息字段
400 NoPicList The body content is missing the pic_list parameter. 未指定pic_list字段
400 InvalidPicList The specified pic_list parameter is invalid. 无效的pic_list字段
400 NoSpecifiedPic The content of an image is not specified in the HTTP POST body. 图片未指定
400 InvalidCategory The specified category is invalid. 无效的类目id
400 OverflowMaxResultNum The specified number of total results exceeds the maximum of 500. 超过了最大的返回结果限制数500
400 OverflowMaxReturnNum The specified number of results for each request exceeds the maximum of 100. 单次返回数超过限制值100
400 InvalidIntAttr The specified int_attr field is invalid. 无效的int过滤字段
400 UnsupportedPicFormat The specified image format is invalid. 无效的图片格式
400 InvalidFilterClause The specified filtering condition is invalid. 无效的过滤条件
400 InstanceOverQuota The number of items exceeds the limit. 实例的图片数量超过限制值
400 IncorrectOrientation The image contains incorrect rotation flags in the meta data. 图片包含不支持的旋转参数
400 UnsupportedPicPixels The specified pixels is not supported. 图片像素值不支持
403 NoPermission You are not authorized to perform this operation. 未授权的行为
403 DeniedRequest Your request was denied due to instance flow control. 请求被限流
500 InternalError An internal server error occurred. 内部错误
500 NetworkException A network error occurred. 内部错误:请求网络异常
500 UnsupportedInstanceType The instance type is not supported. 内部错误:不支持的实例类型
500 UnsupportedOperationType The specified action is not supported. 内部错误:不支持的action
500 AccessEngineFailed An error occurred while accessing the search engine. 内部错误:请求引擎失败
500 InternalOssError An internal OAS error occurred. 内部错误:请求内部算法错误
500 InternalSwiftError An internal SWIFT error occurred. 内部错误:请求内部消息队列错误
500 InternalTableStoreError An internal Table Store error occurred. 内部错误:请求特征存储错误

访问错误中心查看更多错误码。

错误码

请参见错误码