跳到主要内容

自定义图库搜索

1. 任务简介​

1.1 任务 ID​

5c8f44ca25ade48455a63bad

提示

任务 ID 全局固定且不变，建议客户将其定义为代码常量。

1.2 能力介绍​

  • 自定义图库配置独立的黑/白名单，能为不同用户提供自定义审核功能，辅助用户识别与图普审核定义不一的数据，从而使审核结果更贴近实际业务场景，更好地应对突发的管控需求。黑名单图库对应的识别结果是拒绝，白名单对应通过。
  • 注意：只有图片相似度达到一定的阈值以上，才会匹配成功。对于图片的调整变形如背景变化、二次翻拍、清晰度改变、裁剪旋转等都将会影响图片匹配效果。

2. 请求参数​

图片接口公共请求参数详见：图片同步识别接口，图片异步识别接口

视频接口公共请求参数详见：视频同步识别接口，视频文件异步识别接口，视频流异步识别接口

3. 返回结果​

3.1 公共返回结果​

图片接口公共返回结果详见：图片同步识别接口，图片异步识别接口

视频接口公共返回结果详见：视频同步识别接口，视频文件异步识别接口，视频流异步识别接口

3.2 任务返回结果 🎯​

任务结果​

参数名称类型是否必需说明
fileListArray是每张图片的识别结果，详见 FileResult 参数说明

FileResult 参数说明​

参数名称类型是否必需说明
nameString是如果上传的 image 参数是 url，则该值是图片 url；如果是以图片文件上传，则该值为文件名
labelInt是识别分类，详见 任务返回标签说明
similarityFloat是与图片的相似度，范围在 [0-1] 之间，分值越高，越相似
relativesArray<RelativeImage>是相似的图片数组，会按照相似度由高到低返回数个结果，仅相似度最高的结果代表本次识别结果。详见 RelativeImage 参数说明
tagString否调用时为该图片设置的 tag 参数

RelativeImage 参数说明​

参数名称类型是否必需说明
nameString是命中的相似图片名称。可以由调用方根据业务需求自定义 name，关联到业务数据
pathString是命中的相似图片链接
scoreFloat是与命中图片的相似度，范围在 [0-1] 之间，分值越高，越相似
imageLibraryIdString是命中图片所在的图片名单库 id

任务结果​

参数名称类型是否必需说明
fileListArray是每张图片的识别结果，详见 FileResult 参数说明

FileResult 参数说明​

参数名称类型是否必需说明
nameString是视频截图文件名称
labelInt是识别分类，详见 任务返回标签说明
similarityFloat是与图片的相似度，范围在 [0-1] 之间，分值越高，越相似
relativesArray<RelativeImage>是相似的图片数组，会按照相似度由高到低返回数个结果，仅相似度最高的结果代表本次识别结果。详见 RelativeImage 参数说明
urlString是视频截图文件链接，有效期 7 天
secondFloat是视频截图时间点，表示在第 N 秒截取了该图片。

1. 对于视频流，值为开始截图后的相对时间点

RelativeImage 参数说明​

参数名称类型是否必需说明
nameString是命中的相似图片名称。可以由调用方根据业务需求自定义 name，关联到业务数据
pathString是命中的相似图片链接
scoreFloat是与命中图片的相似度，范围在 [0-1] 之间，分值越高，越相似
imageLibraryIdString是命中图片所在的图片名单库 id

任务结果​

参数名称类型是否必需说明
fileListArray是每张图片的识别结果，详见 FileResult 参数说明

FileResult 参数说明​

参数名称类型是否必需说明
nameString是视频截图文件名称
labelInt是识别分类，详见 任务返回标签说明
similarityFloat是与图片的相似度，范围在 [0-1] 之间，分值越高，越相似
relativesArray<RelativeImage>是相似的图片数组，会按照相似度由高到低返回数个结果，仅相似度最高的结果代表本次识别结果。详见 RelativeImage 参数说明
urlString是视频截图文件链接，有效期 7 天
secondFloat是视频截图时间点，表示在第 N 秒截取了该图片。

1. 对于视频流，值为开始截图后的相对时间点

RelativeImage 参数说明​

参数名称类型是否必需说明
nameString是命中的相似图片名称。可以由调用方根据业务需求自定义 name，关联到业务数据
pathString是命中的相似图片链接
scoreFloat是与命中图片的相似度，范围在 [0-1] 之间，分值越高，越相似
imageLibraryIdString是命中图片所在的图片名单库 id

任务结果​

参数名称类型是否必需说明
fileListArray是每张图片的识别结果，详见 FileResult 参数说明

FileResult 参数说明​

参数名称类型是否必需说明
labelInt是识别分类，详见 任务返回标签说明
similarityFloat是与图片的相似度，范围在 [0-1] 之间，分值越高，越相似
relativesArray<RelativeImage>是相似的图片数组，会按照相似度由高到低返回数个结果，仅相似度最高的结果代表本次识别结果。详见 RelativeImage 参数说明
nameString是图片名称，根据所在页及图片索引生成，用以唯一标识文档中的图片

RelativeImage 参数说明​

参数名称类型是否必需说明
nameString是命中的相似图片名称。可以由调用方根据业务需求自定义 name，关联到业务数据
pathString是命中的相似图片链接
scoreFloat是与命中图片的相似度，范围在 [0-1] 之间，分值越高，越相似
imageLibraryIdString是命中图片所在的图片名单库 id

3.3 任务返回标签说明 🎯🎯​

label说明描述
0黑名单该图片在库且命中了黑名单库
1白名单该图片在库且命中了白名单库
2不在库该图片不在库（相似度小于图片名单库阈值）

3.4 任务结果示例​

{
  "5c8f44ca25ade48455a63bad": {
    "fileList": [
      {
        "label": 2,
        "similarity": 0.64,
        "tag": "test",
        "name": "<name>",
        "relatives": [
          {
            "name": "item-1",
            "path": "https://static.tuputech.com/lts/image/original/lts-52/LTS-Bucket-UserDefineImages/2019-03-29/cloud-api/storage-0831/2019-03-29/10/0.9202317260827633/15538277415580.7420568768203986.jpg",
            "score": 0.64
          }
        ]
      }
    ]
  }
}
{
  "5c8f44ca25ade48455a63bad": {
    "fileList": [
      {
        "label": 2,
        "similarity": 0.64,
        "name": "82ffc7248926472d9ea83c27084fdcff-1",
        "url": "<url>",
        "second": 1,
        "relatives": [
          {
            "name": "item-1",
            "path": "https://static.tuputech.com/lts/image/original/lts-52/LTS-Bucket-UserDefineImages/2019-03-29/cloud-api/storage-0831/2019-03-29/10/0.9202317260827633/15538277415580.7420568768203986.jpg",
            "score": 0.64
          }
        ]
      }
    ]
  }
}
{
  "5c8f44ca25ade48455a63bad": {
    "fileList": [
      {
        "label": 2,
        "similarity": 0.64,
        "name": "82ffc7248926472d9ea83c27084fdcff-1",
        "url": "<url>",
        "second": 1,
        "relatives": [
          {
            "name": "item-1",
            "path": "https://static.tuputech.com/lts/image/original/lts-52/LTS-Bucket-UserDefineImages/2019-03-29/cloud-api/storage-0831/2019-03-29/10/0.9202317260827633/15538277415580.7420568768203986.jpg",
            "score": 0.64
          }
        ]
      }
    ]
  }
}
{
  "5c8f44ca25ade48455a63bad": {
    "fileList": [
      {
        "label": 2,
        "similarity": 0.64,
        "name": "82ffc7248926472d9ea83c27084fdcff-1-1",
        "relatives": [
          {
            "name": "item-1",
            "path": "https://static.tuputech.com/lts/image/original/lts-52/LTS-Bucket-UserDefineImages/2019-03-29/cloud-api/storage-0831/2019-03-29/10/0.9202317260827633/15538277415580.7420568768203986.jpg",
            "score": 0.64
          }
        ]
      }
    ]
  }
}