调用本接口向指定的相似图库中添加样本图片。
使用说明
业务接口:/green/similarity/image/add
添加相似图样本时,您可以为图片设置标签。如果样本图片在检索时被命中,其标签信息也会被返回。
新增相似图样本在1分钟之内生效。
待检测图片需要满足以下要求:
- 图片链接支持以下协议:HTTP和HTTPS。
- 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
- 图片大小限制为20 MB以内(适用于同步和异步调用),高度或者宽度不能超过30,000像素(px),且图像总像素不超过2.5亿(px)。
- 图片下载时间限制为3秒内,如果下载时间超过3秒,返回下载超时。
- 图片像素建议不低于256*256(px),像素过低可能会影响识别效果。
- 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。
QPS限制
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
tasks | JSONArray | 是 | 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素是个结构体具体结构描述,请参见task。 | |
library | String | 否 | test | 要操作的图库的名称。如果不指定该参数,那么图片样本将被添加到默认图库中。默认图库名称为default。 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
dataId | String | 否 | 1 | 该样本在您的业务系统里的唯一ID。例如,您可以指定该样本ID为“1”、“s-001”等。 |
url | String | 是 | http://example.com/1.jpg | 样本图片的URL。 |
tags | JSONArray | 否 | ["涉黄","渉政"] | 为该样本图片设置标签。每个元素是字符串,最多允许设置3个标签值。例如,您可以为样本图片添加如下标签:["涉黄", "渉政"] 。
说明 在命中该样本时,会返回相应的标签信息。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 200 | 错误码,和HTTP状态码一致。
更多信息,请参见公共错误码。 |
msg | String | OK | 请求信息的响应消息。 |
dataId | String | 1 | 对应请求中的dataId。 |
url | String | http://example.com/1.jpg | 对应请求中的url。 |
示例
请求示例
http(s)://[Endpoint]/green/similarity/image/add
&<公共请求参数>
{
"tasks": [
{
"dataId": "1",
"url": "http://example.com/1.jpg",
"tags": [
"涉黄",
"渉政"
]
},
{
"dataId": "2",
"url": "http://example.com/2.jpg",
"tags": [
"涉黄",
"渉政"
]
}
],
"library": "test"
}
返回示例
{
"msg": "OK",
"code": 200,
"requestId": "33921869-CF8A-4E62-8C31-44F37341FFC1",
"data": [
{
"code": 200,
"msg": "OK",
"dataId": "1",
"url": "http://example.com/1.jpg"
},
{
"code": 200,
"msg": "OK",
"dataId": "2",
"url": "http://example.com/2.jpg"
}
]
}