You need to enable JavaScript to run this app.
导航
使用图片去重获取结果值
最近更新时间:2024.07.16 10:21:01首次发布时间:2022.10.12 11:42:27

本接口支持通过对图片的特征提取、特征比较、相似度计算,获取相似度分值和相似图片分组。

说明

  • 支持同步或异步去重,如果输入两张以上图片推荐您使用异步去重处理。
  • 如果使用异步去重,则最终去重的图片评分以及图片分组结果请调用 GetDedupTaskStatus接口查看。

注意事项

  • 计费说明:图片去重功能属于附加组件下智能处理模块,属于后付费计费,使用后会产生附加组件智能处理费用

    注意

    图像去重实际计量计费次数根据输入原图张数有关,具体规则如下所示:

    • 仅输入两张图片:固定仅按照 1 次作为计量计费次数。
    • 输入 2 张以上图片:以各图片特征提取次数与两两图片相似度匹配次数之和作为计量计费次数。
  • 前提条件:请确保已开通智能处理计费配置
  • 使用限制:使用前,请先确认图片去重使用限制
  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:超时时间约为 30 秒
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST

  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageDuplicateDetection&Version=2018-08-01

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

参数类型是否必选示例值描述
Content-TypeStringapplication/json请求头字段

Query

参数类型是否必选示例值描述
ActionStringGetImageDuplicateDetection接口名称。当前 API 的名称为 GetImageDuplicateDetection
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

ServiceId

String

jc**ko

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

Body

参数类型是否必选示例值描述
UrlsArray 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

true

是否使用异步,支持取值如下所示:

  • true:使用异步去重
  • false:(默认)不使用异步去重
CallbackStringhttp://example.callback.com/testAsync取值为true即启用异步时需要添加回调地址,地址使用 POST 请求方式。回调内容详见回调参数
SimilarityFloat0.84相似度阈值。上传图片数量超过 2 张并执行去重分组时,系统将对原图中满足该阈值的图片进行分组。取值范围为 [0,1],默认值为 0.84。最多支持两位小数。

ExtractorType

String

hash

图像特征提取类型,取值如下所示:

  • hash:(默认)基于图像的像素值、颜色分布、纹理等特征生成哈希码,并通过哈希码进行比较来判定图片的相似度。该方式处理速度快,但对图片的旋转和颜色的敏感度较高,适用于大规模且纹理相对简单的图片的快速去重。
  • cnn:通过深度学习技术来提取图像的高级语义特征,如对象、场景和纹理等,这些特征用于比较不同图像之间的相似性。该提取方式鲁棒性较好,对旋转、缩放和变形的敏感度较低,适用于纹理复杂、细节丰富的图片去重。

返回参数

参数类型示例值描述
ScoreString1.0图片评分,仅在两张图片对比才返回 Score 字段。
GroupsJSON-分组结果,若输入 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 错误码

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示:

回调参数

异步去重任务执行完成后,图片服务调用 Callback 将任务执行结果推送给调用方,结果以 JSON 形式放在请求体中,格式如下。

Name
Type
Description
Status
Integer
异步任务状态:0:任务进行中,1:任务执行成功,2:任务执行失败
TaskId
String
任务 ID
Result
JSON
任务执行结果