本文为您介绍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个字符。
|
PicContent | String | 是 | AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII= | 图片内容。
|
CategoryId | Integer | 否 | 88888888 | 图片类目。具体请参考类目参考。
|
Crop | Boolean | 否 | true | 是否需要进行主体识别。默认true。
对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。 |
Region | String | 否 | 280,486,232,351 | 图片的主体区域,格式为
|
CustomContent | String | 否 | zidingyi | 用户自定义的内容,最多支持4096个字符。 查询时会返回该字段。例如可添加图片的描述等文本。 |
IntAttr | Integer | 否 | 22 | 整数类型属性,可用于查询时过滤,查询时会返回该字段。 |
StrAttr | String | 否 | ss | 字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。 不支持特殊字符比如:\¥$&% |
IntAttr2 | Integer | 否 | 22 | 整数类型属性,可用于查询时过滤,查询时会返回该字段。 2023年1月3号之后创建的实例才能使用。 |
StrAttr2 | String | 否 | ss | 字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。
|
返回数据
示例
请求示例
{
"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限制
- 调试
- 请求参数
- 返回数据
- 示例
- 错误码