跳到主要内容

人脸比对任务

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/history/face-compare/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

1.2 请求方法​

POST

1.3 请求头​

Content-Type: application/json

1.4 请求参数​

参数名称类型是否必需说明
timestampInt是当前服务器的 Unix 时间戳，可以是毫秒或秒级
nonceFloat是随机数（建议使用 Unix 时间戳或若干位随机整数）
signatureString是

RSA-SHA256 算法签名。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权。

签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名方式及示例
startTimeString是时间范围，起始时间 (时间格式 yyyy-MM-dd hh:mm:ss)
endTimestring是时间范围，结束时间 (时间格式 yyyy-MM-dd hh:mm:ss)
pageInt是分页参数，查询页码
limitInt是分页参数，每页大小
sortInt否排序，-1：倒序，1：顺序
sortByString否排序字段
tagString否用户备注，用于给图片或文本附加额外信息
originalFileString否源文件链接
reviewBoolean否汇总结果，数据状态，是否需要复审
labelsArray<Int>否机器识别标签
similarityObject<Similarity>否相似度参数，详见 Similarity 参数说明

Similarity 参数说明​

参数名称类型是否必须说明
gtFloat否大于值，取值范围 (0~100)
ltFloat否小于值，取值范围 (0~100)

2.1.5 请求示例​

{
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
  "startTime": "2022-12-02 00:00:00",
  "endTime": "2022-12-08 00:00:00",
  "page": 20,
  "limit": 1,
  "similarity": {
    "gt": 50,
    "lt": 70
  },
  "originalFile": "16366309647356046",
  "tag": "tag1",
  "review": false,
  "labels": [
    1,
    2
  ],
  "sort": -1,
  "sortBy": "similarity"
}

2. 响应​

2.1 响应内容​

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数​

参数名称类型是否可能为空说明
hasNextBoolean否是否存在下一页
totalInt否调用记录总数
dataArray<faceCompare>否调用总览信息，详见 faceCompare 参数说明

faceCompare 参数说明​

参数名称类型是否可能为空说明
secretIdString否应用 ID
secretTaskIdString否项目 ID
taskDescIdString否任务 ID
trainRecordIdString否模型 ID
labelInt否识别标签
similarityFloat否识别相似度，(0-100)
reviewBoolean否识别结果，是否需要复审
baseObject<baseDetail>否目标文件识别结果，详见 baseDetail 参数说明
referenceObject<baseDetail>否源文件识别结果，详见 baseDetail 参数说明

baseDetail 参数说明​

参数名称类型是否可能为空说明
filePathString否文件缓存地址
originalFileString否源文件地址
tagString否用户备注，用于给图片或文本附加额外信息
locationArray否被检测到的人脸坐标信息 [ 左上角坐标 , 右上角坐标 , 右下角坐标 , 左下角坐标 ]，坐标值是相对于图片大小的百分比数字，取值范围 (0-1)

2.2.3 响应示例​

{
  "json": "{\"code\":0,\"data\":[{\"secretId\":\"**************\",\"secretTaskId\":\"**************\",\"createTime\":\"2022-12-06T02:58:59.258+08:00\",\"id\":\"V7Kn44QB655kIA8u2pJE\",\"taskDescId\":\"573e9604612013c0611d98f9\",\"trainRecordId\":\"5d1337763ee7e9cb9ce0b021\",\"label\":2,\"similarity\":50.04441488189193,\"review\":false,\"base\":{\"filePath\":\"**************\",\"originalFile\":\"1599837267126579200_16290651305835410.jpg\",\"location\":[[0.34765625,0.10546875],[0.92578125,0.10546875],[0.92578125,0.68359375],[0.34765625,0.68359375]],\"tag\":\"tag1\"},\"reference\":{\"filePath\":\"**************\",\"originalFile\":\"1599837267126579200_16290651305837372.jpg\",\"location\":[[0,0.04296875],[0.7916666666666666,0.04296875],[0.7916666666666666,0.71484375],[0,0.71484375]]}}],\"hasNext\":true,\"message\":\"success\",\"nonce\":0.41335702051849404,\"timestamp\":1670933886,\"total\":463}",
  "signature": "nD1oHikXcvMUR6N+e0GWbGaiopTo7p0lowYES2vGMotollrV4p0izUWsE8q+RkJc0PBMdOZ000C7WufgsWNcmfxeuPC0SIPzT9GgChZbzegYDuadPA16ieJHobYOnDn9Dcc6j3raeJU2Ojv3T2fSJ+/d+ycHemtYbc6mTbVv5HY="
}

json 字段示例

{
  "code": 0,
  "data": [
    {
      "secretId": "**************",
      "secretTaskId": "**************",
      "createTime": "2022-12-06T02:58:59.258+08:00",
      "id": "V7Kn44QB655kIA8u2pJE",
      "taskDescId": "573e9604612013c0611d98f9",
      "trainRecordId": "5d1337763ee7e9cb9ce0b021",
      "label": 2,
      "similarity": 50.04441488189193,
      "review": false,
      "base": {
        "filePath": "**************",
        "originalFile": "1599837267126579200_16290651305835410.jpg",
        "location": [
          [
            0.34765625,
            0.10546875
          ],
          [
            0.92578125,
            0.10546875
          ],
          [
            0.92578125,
            0.68359375
          ],
          [
            0.34765625,
            0.68359375
          ]
        ],
        "tag": "tag1"
      },
      "reference": {
        "filePath": "**************",
        "originalFile": "1599837267126579200_16290651305837372.jpg",
        "location": [
          [
            0,
            0.04296875
          ],
          [
            0.7916666666666666,
            0.04296875
          ],
          [
            0.7916666666666666,
            0.71484375
          ],
          [
            0,
            0.71484375
          ]
        ]
      }
    }
  ],
  "hasNext": true,
  "message": "success",
  "nonce": 0.41335702051849404,
  "timestamp": 1670933886,
  "total": 463
}