调用本接口检测指定图片和相似图库中的样本图片的相似度。
使用说明
业务接口:/green/image/scan
待检测图片需要满足以下要求:
- 图片链接支持以下协议: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限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
关于公共请求参数,请参见公共参数。
请求body是一个JSON对象,字段说明如下:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
scenes | String | 是 | similarity | 相似图检索业务下,该参数取值为:similarity。 |
tasks | JSONArray | 是 | 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,请参见task。 |
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
dataId | String | 否 | test6HPBmBm8AM46zcu30bRNq0-1p8xDK | 待检测图片在您的业务系统中的唯一ID。 |
url | String | 是 | http://example.com/testb.jpg | 待检测图片的URL。 |
similarityLibraries | StringArray | 否 | ["xxx"] | 指定要检索的相似图库的名称。如果不指定该参数,即从默认图库中检索。默认图库的名称为default。 |
返回数据
关于返回参数的说明,请参见返回结果。
返回body中的data字段是JSON数组,每一个元素包含如下字段:
名称 | 类型 | 示例值 | 描述 |
---|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 200 | 错误码,和HTTP状态码一致。
更多信息,请参见公共错误码。 |
msg | String | OK | 请求信息的响应消息。 |
results | JSONArray | 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素,每个元素是个结构体。关于具体结构的描述,请参见result。 |
名称 | 类型 | 示例值 | 描述 |
---|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
scene | String | similarity | 检测场景,取值:similarity。 |
label | String | normal | 检测结果分类,和调用请求的scene对应。相似图检索业务下,该参数取值为:
|
suggestion | String | review | 建议用户执行的操作,取值:
|
rate | Float | 99.9 | 与所有命中的样本图片的相似度的最大值,取值范围为[0.00-100.00]。值越高,表示越有可能命中样本图片。 |
similarityImage | JSONArray | 命中的相似图结果。返回被检测图片与样本图库中所有图片比对后,相似度高的结果记录。每个记录的具体结构描述,请参见similarityImageData。 |
名称 | 类型 | 示例值 | 描述 |
---|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
dataId | String | test6HPBmBm8AM46zcu30bRNq0-1p8xDK | 命中的样本图片在您的业务系统里的唯一ID。 |
url | String | http://example.com/testb.jpg | 命中的样本图片的URL。 |
tags | JSONArray | ["涉黄"] | 命中的样本图片的标签值。 |
rate | Float | 99.9 | 被检测图片与命中的样本图片的相似度,取值范围为[0.00-100.00]。值越高,表示越有可能命中该样本图片。 |
library | String | xxx | 样本图片所在图库的名称。 |
示例
请求示例
http(s)://[Endpoint]/green/image/scan
&<公共请求参数>
{
"scenes":["similarity"],
"tasks":[
{
"url":"http://example.com/test.jpg",
"similarityLibraries":["xxx"]
}
]
}
返回示例
{
"requestId":"7B932A87-65EB-423A-A4BF-BDA65E29FCEE",
"code":200,
"msg":"OK",
"data":[
{
"code":200,
"msg":"OK",
"results":[
{
"label":"normal",
"rate":99.9,
"scene":"similarity",
"suggestion":"review",
"similarityImageData":[
"url": "http://example.com/testb.jpg",
"dataId": "test6HPBmBm8AM46zcu30bRNq0-1p8xDK",
"rate": 99.9,
"tags":["涉黄"],
"library":"xxx"
]
}
],
"taskId":"img3IpdHbwwbv05pvXD8ud7F0-1p8xDC",
"url":"http://example.com/test.jpg"
}
]
}