查询文本应用调用记录

1. 请求

1.1 请求地址

区域	请求地址
国内	https://api.open.tuputech.com/v3/management/history/text/<secretId>

提示

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

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称	类型	是否必需	说明
timestamp	String	是	当前服务器的 Unix 时间戳，可以是毫秒或秒级
nonce	String	是	随机数
signature	String	是	RSA-SHA256 算法签名。签名步骤： 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString； 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥 点击 签名及验证示例 查看签名示例
startTime	String	是	时间范围，起始时间 (时间格式 yyyy-MM-dd hh:mm:ss)
endTime	string	是	时间范围，结束时间 (时间格式 yyyy-MM-dd hh:mm:ss)
page	Number	是	分页参数，查询页码
limit	Number	是	分页参数，每页大小
sort	Number	否	排序，-1：倒序，1：顺序
sortBy	String	否	排序字段
review	Boolean	否	识别结果，是否需要复审
userId	String	否	用户 ID
forumId	String	否	板块 ID
content	String	否	关键字查询
labels	Array<Number>	否	识别标签。具体标签值请参考 文本识别（审核）- 返回标签说明 。

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,
  "review": false,
  "content": "hello world",
  "labels": [1,2],
  "sort": -1,
  "sortBy": "createTime"
}

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称	类型	是否可能为空	说明
hasNext	Boolean	否	是否存在下一页
total	Number	否	调用记录总数
data	Array<textData>	否	调用总览信息，详见 textData 参数说明

textData 参数说明

参数名称	类型	是否可能为空	说明
secretTaskId	String	否	项目 ID
content	String	否	文本内容
action	String	否	是否违规，pass：通过 / block：违规 / review：复审
riskType	Number	否	汇总结果，风险类型
suggestion	Number	否	汇总结果，建议操作
review	Boolean	否	识别结果，是否需要复审
label	Number	否	识别结果标签，具体标签值请参考 文本识别（审核）- 返回标签说明 。
labelRate	Number	否	识别结果，标签得分
details	Array<textDetail>	是	识别结果，详见 textDetail 参数说明

textDetail 参数说明

参数名称	类型	是否可能为空	说明
keyword	String	否	命中关键词
hint	String	否	违规内容
mainLabel	String	否	一级标签，详见 文本识别（审核）- 返回标签说明
subLabel	String	是	二级标签
startPos	Number	否	违规内容在文本的中起始位置
endPos	Number	否	违规内容在文本中的结束位置

2.3 响应示例

{
  "json": "{\"code\":0,\"data\":[{\"secretTaskId\":\"**************\",\"id\":\"**************\",\"content\":\"你好\",\"action\":\"pass\",\"label\":0,\"labelRate\":1,\"createTime\":\"2022-12-12T23:49:22.503+08:00\",\"review\":false,\"contentId\":\"tp1710960806245497\",\"riskType\":0,\"suggestion\":0,\"details\":[{\"endPos\":229,\"hint\":\"**************\",\"keyword\":\"**************\",\"mainLabel\":\"Politics\",\"startPos\":225,\"subLabel\":\"Political_Negative_events\"}]}],\"hasNext\":true,\"message\":\"success\",\"nonce\":0.9075387221079954,\"timestamp\":1670919584,\"total\":366}",
  "signature": "wViQTFW9vDKhDLkPYZuzmPdaoh8UiFgyzC0vJu1aH2PxL8PZpy8CWXWjKKtG0yO3j9e/0B1uPXyRGEqmmlhmJhRI4+mhvJT9geOyxN2RPSaWqpXhoXVfPeK8l99Y+x+aWOeM9xAH9o6xLssq+oGTGjne8fhQNGQNrEmnzmf20sI="
}

json 字段示例

{
  "code": 0,
  "data": [
    {
      "secretTaskId": "**************",
      "id": "**************",
      "content": "你好",
      "action": "pass",
      "label": 0,
      "labelRate": 1,
      "createTime": "2022-12-12T23:49:22.503+08:00",
      "review": false,
      "contentId": "tp1710960806245497",
      "riskType": 0,
      "suggestion": 0,
      "details": [
        {
          "endPos": 229,
          "hint": "**************",
          "keyword": "**************",
          "mainLabel": "Politics",
          "startPos": 225,
          "subLabel": "Political_Negative_events"
        }
      ]
    }
  ],
  "hasNext": true,
  "message": "success",
  "nonce": 0.9075387221079954,
  "timestamp": 1670919584,
  "total": 366
}