跳到主要内容

文本同步识别

1. 接口介绍​

该接口对文本中的色情、涉政、暴恐、敏感、广告、谩骂等违法低质内容进行识别及过滤，并实时返回审核结果。 业务流程如下：

提示
  • 接口并发限制：默认每秒请求数不超过 50 次；
  • 字数限制：同步文本识别接口最大支持 2,000 个字符识别；
  • 支持语种：文本审核默认识别中英文，如需识别其他语种（例如，日语、韩语、泰语、越南语、马来语、印尼语、 印地语、菲律宾语、阿拉伯语、土耳其语、俄语、德语、法语、意大利语、西班牙语、葡萄牙语等）中的风险内容， 请联系我们进行相应配置，以保证识别效果。

2. 请求​

2.1 请求地址​

区域请求地址
国内https://api.text.tuputech.com/v3/recognition/text/<secretId>
国外https://api-oversea.text.tuputech.com/v3/recognition/text/<secretId>
提示

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

2.2 请求方法​

POST

2.3 请求头​

Content-Type: application/json

2.4 超时时间及异常处理​

建议配置超时时间 1 秒（如文本较长，建议适当增加超时时间），在 HTTP 响应状态码非 200 或业务状态码不为 0 时进行重试。

2.5 请求参数说明 🔥​

参数名称类型是否必填说明
textArray<Text>是文本内容, 详见 Text 参数说明
nonceNumber是随机数
timestampNumber是当前服务器的 Unix 时间戳
signatureString是

RSA-SHA256 算法签名。签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例

Text 参数说明​

参数名称类型是否必填说明
contentString是待检测的文本内容，最大支持 2,000 字符
contentIdString否（建议填入）自定义文本 ID（指定时可在控制台根据此字段搜索识别结果）
userIdString否用户 ID（指定时可在控制台根据此字段搜索识别结果）
forumIdString否板块 ID（指定时可在控制台根据此字段搜索识别结果）

2.6 请求示例​

{
  "text": [
    {
      "content": "<文本内容>",
      "contentId": "<文本 ID>",
      "userId": "<用户 ID>",
      "forumId": "<板块 ID>"
    }
  ],
  "nonce": 1685000000,
  "timestamp": 1685000000,
  "signature": "<signature>"
}

3. 同步响应​

3.1 响应参数说明 🔥🔥​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0, \"message\":\"success\"}；
  • 字段详见下述 JSON 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

JSON 参数说明​

参数名称类型是否必有说明
codeNumber是请求状态码，详见 业务状态码
messageString是状态信息
summaryArray<Summary>是应用下所有任务的汇总结果，数组长度与入参图片数量对应，汇总结果详见 汇总结果解析。summary 参数详见 Summary 参数说明
imageInfoImageInfo否图片进行了预处理时（动态图片拆分静态图片、长图切分），解析到的图片信息。详见 ImageInfo 参数说明
<任务 ID>Object是识别任务的结果，每个识别任务会有 全局固定不变 的 taskId 和对应数据结构，详见下述链接：

1. 图片类任务结果
2. 文本类任务结果
3. 语音类任务结果
timestampNumber是当前服务器的 Unix 时间戳
nonceNumber是随机数

Summary 参数说明​

参数名称类型是否必有说明
codeNumber是图片识别状态码，详见 业务状态码
nameString是图片 url 或文件名
suggestionNumber否建议的操作，详见汇总结果解析中的 Suggestion 处理建议说明
riskTypeNumber否风险类型，详见汇总结果解析中的 RiskType 风险类型说明
riskTaskString否风险任务 ID
tagString否图片业务信息

3.2 响应示例​

{
  "code": 0,
  "message": "success",
  "summary": [
    {
      "suggestion": 1,
      "riskType": 1,
      "riskTask": "57c4036c557603652aeeb222",
      "code": 0,
      "message": "ok"
    }
  ],
  "57c4036c557603652aeeb222": {
    "texts": [
      {
        "content": "<文本内容>",
        "action": "block",
        "label": "Politics",
        "review": false,
        "rate": 1,
        "details": [
          {
            "keyword": "<关键词>",
            "hint": "<文本内容>",
            "mainLabel": "Politics",
            "subLabel": "Political_Negative_events",
            "startPos": 0,
            "endPos": 3
          }
        ]
      }
    ]
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}