最近更新时间:2023.08.11 18:00:58
首次发布时间:2022.10.12 11:42:27
本接口支持指定服务 ID 以及待去重原图 URL 数组,获取去重结果。
说明
请求频率:单用户请求频率限制为 10 次/秒。
超时时间:超时时间约为 30 秒。
前提条件:已开通图片去重组件能力。
计费说明:图片去重功能属于增值服务项,故使用后会产生增值服务费用,当前支持后付费的计费方式。具体计费详情请参考后付费-按量计费。
注意
图像去重实际计量计费次数根据输入原图张数有关,具体规则如下所示:
请求方式:POST
请求地址:https://imagex.volcengineapi.com/?Action=GetImageDuplicateDetection&Version=2018-08-01
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 请求头字段 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetImageDuplicateDetection | 接口名称。当前 API 的名称为 GetImageDuplicateDetection 。 |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
ServiceId | String | 是 |
| 服务 ID。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Urls | Array of String | 是 | https://test.imagex.cn/obj/tos-cn-i-jc**ko/ee**7e | 需要去重的图片 URL,以英文逗号分割,输入图片格式 PNG,JPEG,支持格式混合输入。 |
Async | Boolean | 否 |
| 是否使用异步,支持取值如下所示:
|
Callback | String | 否 | http://localhost:6901/top/v1/test | 当Async 取值为true 即启用异步时需要添加回调地址,地址使用 POST 请求方式。 |
Similarity | Float | 否 | 0.84 | 相似度阈值。上传图片数量超过 2 张并执行去重分组时,系统将对原图中满足该阈值的图片进行分组。取值范围为 [0,1],默认值为 0.84。最多支持两位小数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Score | String | 1.0 | 图片评分,仅在两张图片对比才返回 Score 字段。 |
Groups | JSON | - | 分组结果,若输入 2 个以上原图时,将按组返回内容相同的图片,每组的图片个数非固定值。 |
POST https://imagex.volcengineapi.com/?Action=GetImageDuplicateDetection&Version=2018-08-01&ServiceId=fc**f9 { "Urls":[ "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee***3e", "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee***3e" ] }
传入多张图时,返回示例如下所示。{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetImageDuplicateDetection", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "Score": "1.0", "Groups": { "group0": [ "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee****7e", "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee****7e" ] } } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "GetImageDuplicateDetection", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "Groups": { "group0": [ "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee****7e", "https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee****7e" ], "group1": [ "https://test.imagex.cn/obj/tos-cn-i-jc****ko/1e****61", "https://test.imagex.cn/obj/tos-cn-i-jc****ko/8t****9n" ] } } }
异步去重任务执行完成后,图片服务调用 Callback 将任务执行结果推送给调用方,结果以 JSON 形式放在请求体中,格式如下。
Name | Type | Description |
---|---|---|
Status | Integer | 异步任务状态:0:任务进行中,1:任务执行成功,2:任务执行失败 |
TaskId | String | 任务 ID |
Result | JSON | 任务执行结果 |