跳到主要内容

通用图片识别任务调用记录

通用图片识别任务调用记录接口仅适用于除了人脸比对以及活体检测任务以外的图片识别任务。

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/history/image/<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否源文件链接
suggestionArray<Int>否各任务汇总结果的处理建议，详见 汇总结果解析 - Suggestion
riskTypeArray<Int>否各任务汇总结果的风险类型，详见 汇总结果解析 - RiskType
fetchAllTaskDetailBoolean否是否返回该应用下所有任务的单独检测结果。默认为false，仅返回所有任务的汇总结果。
taskObject<taskDetail>否任务详情，详见 taskDetail 参数说明

taskDetail 参数说明​

参数名称类型是否必需说明
taskIdString否识别任务 ID
labelsArray<Int>否机器识别标签

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,
  "fetchAllTaskDetail": false,
  "suggestion": [0],
  "riskType": [0],
  "task": {
    "taskId": "616f96b0a99edfb704c685cb",
    "labels": [2]
    },
  "tag":"testTag",
  "originalFile":"testFilePath",
  "sort": -1,
  "sortBy": "createTime",
}

2. 响应​

2.1 响应内容​

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

2.2 响应参数​

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

imageHistory 参数说明​

参数名称类型是否可能为空说明
secretIdString否应用 (SID)
filePathString否文件缓存地址
originalFileString否源文件链接
suggestionInt否各任务汇总结果的处理建议，详见 汇总结果解析 - Suggestion
riskTypeInt否各任务汇总结果的风险类型，详见 汇总结果解析 - RiskType
tagString是用户备注，用于给图片或文本附加额外信息
tasksObject<taskDetail>否任务识别结果。每个任务识别结果的 taskDetail 由项目 ID 作为字段，具体任务识别结果作为字段值进行展示。具体任务识别结果请根据识别任务类型参考 识别接口文档返回结果

2.3 响应示例​

以下展示了 fetchAllTaskDetail 为不同值时的响应结果示例：

响应结果​

{
    "json": "{\"code\":0,\"data\":[{\"secretId\":\"**************\",\"createTime\":\"2022-12-06T12:29:28.340+08:00\",\"id\":\"Ua6y5YQBw6N0Xj9YJYvm\",\"filePath\":\"**************\",\"originalFile\":\"**************\",\"riskType\":0,\"suggestion\":0,\"tag\":\"1011\"}],\"hasNext\":true,\"message\":\"success\",\"nonce\":0.5234538520479244,\"timestamp\":1670900739,\"total\":1802}",
    "signature": "v20eG2bIgK0e7sRJzQLVVPtjuEdlsP4hfMWU2c6GkFc8CZQedR/HX1zdzwnzNpgFjUd2LcdWq49czV3QXkmF2jjLuBa680kMgnukmABhNnnJ67eI5N4PTEX42mQ9fk5zjVLXPJBYpjcaoxAA0hDO+MPJRkcHySWuvcfXybN5tUQ="
}

json 字段示例​

{
    "code": 0,
    "data": [
        {
            "secretId": "**************",
            "createTime": "2022-12-06T12:29:28.340+08:00",
            "id": "Ua6y5YQBw6N0Xj9YJYvm",
            "filePath": "**************",
            "originalFile": "**************",
            "riskType": 0,
            "suggestion": 0,
            "tag": "1011"
        }
    ],
    "hasNext": true,
    "message": "success",
    "nonce": 0.5234538520479244,
    "timestamp": 1670900739,
    "total": 1802
}