本接口支持通过对图片的特征提取、特征比较、相似度计算，获取相似度分值和相似图片分组。
说明
注意
图像去重实际计量计费次数根据输入原图张数有关，具体规则如下所示：
请求方式：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","https://test.imagex.cn/obj/tos-cn-i-jc****ko/ee****7e"] | 需要去重的图片 URL，多个地址以英文逗号分割。图片格式仅支持 JPEG（.jpeg 或 .jpg）和 PNG，支持格式混合输入。 |
Async | Boolean | 否 |
| 是否使用异步，支持取值如下所示：
|
| Callback | String | 否 | http://example.callback.com/test | 当Async取值为true即启用异步时需要添加回调地址，地址使用 POST 请求方式。回调内容详见回调参数。 |
| Similarity | Float | 否 | 0.84 | 相似度阈值。上传图片数量超过 2 张并执行去重分组时，系统将对原图中满足该阈值的图片进行分组。取值范围为 [0,1]，默认值为 0.84。最多支持两位小数。 |
ExtractorType | String | 否 |
| 图像特征提取类型，取值如下所示：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Score | String | 1.0 | 图片评分，仅在两张图片对比才返回 Score 字段。 |
| Groups | JSON | - | 分组结果，若输入 2 个以上原图时，将按组返回内容相同的图片，每组的图片个数非固定值。 |
POST https://imagex.volcengineapi.com/?Action=GetImageDuplicateDetection&Version=2018-08-01&ServiceId=jc****ko { "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" ] } } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。
为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：
异步去重任务执行完成后，图片服务调用 Callback 将任务执行结果推送给调用方，结果以 JSON 形式放在请求体中，格式如下。
Name | Type | Description |
|---|---|---|
Status | Integer | 异步任务状态：0：任务进行中，1：任务执行成功，2：任务执行失败 |
TaskId | String | 任务 ID |
Result | JSON | 任务执行结果 |