文档

文本人工审核

更新时间:

本文介绍了调用文本人工审核接口(/green/text/manual/asyncScan)进行人工审核的方法。内容安全除了提供机器识别服务外,还提供纯人工审核服务,如果您对识别结果的准确率和召回率要求非常高,请使用人工审核功能。

说明

使用该服务前,请联系我们的商务经理,进一步确定审核标准与内容范围。调用该接口不会返回机器识别结果,如果您需要机器识别的结果,请调用检测服务接口。检测服务的接口信息,请参见文本同步检测

(文本人工审核)使用说明

业务接口:/green/text/manual/asyncScan

人工审核接口不实时返回检测结果,您需要通过callback或轮询方式获取。检测结果最长保留期限为30天。

  • 计费信息

    该接口为收费接口。关于计费方式,请参见内容安全产品定价

  • 返回结果

    人工审核的返回结果时长根据待审核数据的量而定。

    • callback获取审核结果:提交人工审核任务时,在请求参数中传入callback参数,用来自动接收检测结果。更多信息,请参见请求参数

    • 轮询获取审核结果:提交人工审核任务时,无需传入callback参数。提交人工审核任务后,调用结果查询接口获取检测结果。更多信息,请参见结果查询接口说明

关于该接口的使用指南,请参见接入人工审核服务

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

(人工审核)请求参数

关于在请求中必须包含的公共请求参数,请参见公共参数

请求body是一个JSON结构体,包含以下字段:

名称

类型

是否必选

示例值

描述

callback

String

http://aliyundoc.com

callback接口必须支持POST方法、UTF-8编码的传输数据,以及表单参数checksumcontent。内容安全按照以下规则和格式设置checksumcontent,调用您的callback接口返回检测结果。

  • checksum:字符串格式,由用户uid + seed + content拼成字符串,通过SHA256算法生成。用户UID即阿里云账号ID,可以在阿里云控制台查询。为防篡改,您可以在获取到推送结果时,按上述算法生成字符串,与checksum做一次校验。

    说明

    用户UID必须是阿里云账号的UID,而不是RAM用户的UID。

  • content:JSON字符串格式,请自行解析反转成JSON对象。关于content结果的示例,请参见查询检测结果的返回示例。

说明

您的服务端callback接口收到内容安全推送的结果后,如果返回的HTTP状态码为200,则表示接收成功,其他的HTTP状态码均视为接收失败。接收失败时,内容安全将最多重复推送16次检测结果,直到接收成功。重复推送16次后仍未接收成功,则不再推送,建议您检查callback接口的状态。

seed

String

seedxxx

随机字符串,该值用于回调通知请求中的签名。

由英文字母、数字、下划线(_)组成,不超过64个字符。由您自定义,用于在接收到内容安全的回调通知时校验请求由阿里云内容安全服务发起。

说明

当使用callback时,该字段必须提供。

tasks

JSONArray

指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,请参见task

表 1. task

名称

类型

是否必选

示例值

描述

content

String

test

待人工审核的文本内容,最长不超过10000个字符(包含中文、英文和标点符号)。

dataId

String

dataIdxxxx

检测对象对应的数据ID。

由大小写英文字母、数字、下划线(_)、短划线(-)、英文句号(.)组成,不超过128个字符,可以用于唯一标识您的业务数据。

(人工审核)返回数据

名称

类型

示例值

描述

code

Integer

200

错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

data

JSONArray

本次请求返回的数据体。数组中每个元素表示一个人工审核任务的结果。关于每个元素的具体结构描述,请参见data

msg

String

OK

本次请求的响应信息。

requestId

String

2C01A0EE-B5BF-429B-898A-9F6D301342EB

请求ID。

表 2. data

名称

类型

示例值

描述

code

Integer

200

错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

dataId

String

dataIdxxxx

检测对象对应的数据ID。

说明

如果在检测请求参数中传入了dataId,则此处返回对应的dataId

msg

String

OK

该检测任务的响应信息。

taskId

String

txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX

该人工审核任务的ID。后续您可以使用该ID调用结果接口,查询人工审核任务的结果。

content

String

text

待人工审核的文本内容,最长不超过10000个字符(包含中文、英文和标点符号)。

(人工审核)示例

请求示例

http(s)://[Endpoint]/green/text/manual/asyncScan
&<公共请求参数>
{
    "callback": "http://aliyundoc.com",
    "seed": "seedxxx",
    "tasks": [{
        "content": "test text",
        "dataId": "dataIdxxxx"
    }]
}

正常返回示例

{
    "code": 200,
    "data": [{
        "code": 200,
        "content": "test text",
        "dataId": "dataIdxxxx",
        "msg": "OK",
        "taskId": "txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX"
    }],
    "msg": "OK",
    "requestId": "2C01A0EE-B5BF-429B-898A-9F6D301342EB"
}

(文本人工审核结果查询)使用说明

业务接口:/green/text/manual/scan/results,表示查询文本人工审核的结果。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

(结果查询)请求参数

名称

类型

是否必选

示例值

描述

body

StringArray

["txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX"]

待查询的人工审核任务的taskId列表。数组中的元素个数不超过100个。

(结果查询)返回数据

名称

类型

示例值

描述

code

Integer

200

错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

data

JSONArray

本次请求返回的数据体。数组中每个元素表示一个人工审核任务的结果。关于每个元素的具体结构描述,请参见data

msg

String

OK

本次请求的响应信息。

requestId

String

2061F868-396C-4F00-9F32-792914428EA1

请求ID。

表 3. data

名称

类型

示例值

描述

code

Integer

200

错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

dataId

String

dataIdxxxx

检测对象对应的数据ID。

说明

如果在检测请求参数中传入了dataId,则此处返回对应的dataId

msg

String

OK

该检测任务的响应信息。

suggestion

String

block

建议您执行的后续操作。取值:

  • pass:结果正常,无需进行其余操作。

  • block:结果违规,建议直接删除或者限制公开。

taskId

String

txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX

任务ID。

content

String

test text xxx

人工审核的文本内容。

(结果查询)示例

请求示例

http(s)://[Endpoint]/green/text/manual/scan/results
&<公共请求参数>
[
    "txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX"
]

正常返回示例

{
    "code": 200,
    "data": [{
        "code": 200,
        "content": "test text xxx",
        "dataId": "dataIdxxxx",
        "msg": "OK",
        "suggestion": "block",
        "taskId": "txt17xfqjr4XWx4FrfsGw5YxL-1tyzBX"
    }],
    "msg": "OK",
    "requestId": "2061F868-396C-4F00-9F32-792914428EA1"
}
  • 本页导读 (0)