新增图片 - 图像搜索

使用说明

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

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秒。服务类型为商标图片搜索时，图片长和宽像素要求大于等于200PX且小于4096PX。服务类型为布料图片搜索时，图片长和宽像素要求大于等于448PX且小于等于4096PX。服务类型为商品图片搜索和通用图片搜索时，图片长和宽像素要求大于等于100PX且小于等于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。
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
}

错误码

HttpCode	错误码	错误信息	描述
400	BadRequest	The request has invalid parameters.	无效的参数
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	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	UnknownException	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.	内部错误：请求特征存储错误

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

错误码

请参见错误码。