文本审核回调内容
下载
聚焦模式
字号
功能描述
若您配置了审核回调地址，在文本审核结束后，后台会将审核结果以 json 形式回调至您的回调地址。您可以通过回调内容，进行后续的文件处理操作。
回调内容分为简洁回调（Simple）和详细回调（Detail）。
回调内容说明
简洁回调（Simple）
回调通知为
HTTP的POST方法，含有 X-Ci-Content-Version: Simple 的头部。该响应体返回为 application/json 数据，包含完整节点数据的内容展示如下：
{"code": 0,"data": {"forbidden_status": 0,"event": "ReviewText","porn_info": {"hit_flag": 0,"label": "","count": 0},"result": 0,"trace_id": "test_trace_id","url": "test_url","cos_headers": {"x-cos-meta-xx": "xx"}},"message": "Test request when setting callback url"}
具体的数据内容如下：
参数名称 | 描述 | 类型 | 是否必选 |
code | Integer | 是 | |
message | 错误描述。 | String | 是 |
data | 文本审核结果的详细信息。 | Object | 是 |
data的具体内容如下：
参数名称 | 描述 | 类型 | 是否必选 |
trace_id | 唯一 ID 标识。如果是通过接口创建的异步任务，则为接口返回的 JobId。 | String | 是 |
url | 被审核文本的完整 URL 链接。 | String | 是 |
event | 触发的事件，此处固定为 ReviewText。 | String | 是 |
result | 该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。 | Integer | 是 |
forbidden_status | 若您设置了自动冻结，该字段表示文本的冻结状态。0：未冻结，1：已被冻结，2：已转移文件。 | Integer | 是 |
cos_headers | 资源上传时设置的自定义 header 内容，若未设置则不返回。 | Object | 否 |
porn_info | 审核场景为涉黄的审核结果信息。 | Object | 否 |
ads_info | 审核场景为广告引导的审核结果信息。 | Object | 否 |
abuse_info | 审核场景为谩骂的审核结果信息。 | Object | 否 |
illegal_info | 审核场景为违法的审核结果信息。 | Object | 否 |
data_id | 提交任务时设置了DataId参数时返回，返回原始内容，长度限制为512字节。 | String | 否 |
xx_info 的具体内容如下：
参数名称 | 描述 | 类型 | 是否必选 |
hit_flag | 用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。 | Integer | 是 |
label | 命中的关键字。 | String | 是 |
count | 命中该审核分类的敏感文本段数。 | Integer | 是 |
详细回调（Detail）
回调通知为
HTTP的POST方法，含有 X-Ci-Content-Version: Detail 的头部。该响应体返回为 application/json 数据，包含完整节点数据的内容展示如下：
{"EventName": "ReviewText","JobsDetail": {"JobId": "xxxxxx","State": "Success","CreationTime": "","Object": "","Label": "Normal","Result": 0,"SectionCount": 1,"PornInfo": {"HitFlag": 0,"Count": 0},"AdsInfo": {"HitFlag": 0,"Count": 0},"IllegalInfo": {"HitFlag": 0,"Count": 0},"AbuseInfo": {"HitFlag": 0,"Count": 0},"Section": [{"StartByte": 0,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""},"IllegalInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""},"AbuseInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""},"AdsInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""}}],"BucketId": "","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "xxxxx"}}}
具体的数据内容如下：
节点名称（关键字） | 描述 | 类型 |
JobsDetail | 任务的详细结果信息。 | Object |
EventName | 任务的类型，为 ReviewText。 | String |
JobsDetail 的具体内容如下：
节点名称（关键字） | 描述 | 类型 |
Code | String | |
Message | 错误描述，只有 State 为 Failed 时返回。 | String |
JobId | 本次文本审核任务的 ID。 | String |
DataId | 提交任务时设置了DataId参数时返回，返回原始内容，长度限制为512字节。 | String |
State | 审核任务的状态，值为 Submitted（已提交审核）、Success（审核成功）、Failed（审核失败）、Auditing（审核中）其中一个。 | String |
CreationTime | 审核任务的创建时间。 | String |
Object | 被审核的文本文件的名称，创建任务使用 Object 时返回。 | String |
Content | 本次审核的文本内容的 Base64编码，当创建任务使用 Content 时返回。 | String |
Label | 该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，Illegal：违法，Abuse：谩骂。 | String |
Result | 该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。 | Integer |
PornInfo | 审核场景为涉黄的审核结果信息。 | Object |
AdsInfo | 审核场景为广告引导的审核结果信息。 | Object |
IllegalInfo | 审核场景为违法的审核结果信息。 | Object |
AbuseInfo | 审核场景为谩骂的审核结果信息。 | Object |
SectionCount | 文本审核会将文本进行分段送审，每10000个 utf8 编码字符分一段，该参数表示分段的数量。 | Integer |
Section | 文本内容每一段的审核结果。 | Array |
BucketId | 创建的审核任务所属的存储桶名称。 | String |
Region | 存储桶所在的地域。 | String |
ForbidState | 若您设置了自动冻结，该字段表示文本的冻结状态。0：未冻结，1：已被冻结，2：已转移文件。 | Integer |
CosHeaders | 资源上传到 COS 时设置的自定义 Header 内容，如果未设置则不返回。map 结构，key 为自定义 Header 的名称，value 为内容。 | Object |
UserInfo | 用户业务字段。 | Container |
ListInfo | 账号黑白名单结果。 | Container |
PornInfo，AdsInfo，IllegalInfo，AbuseInfo 的具体内容如下：
节点名称（关键字） | 描述 | 类型 |
HitFlag | 用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。 | Integer |
Count | 命中该审核分类的文本段数。 | Integer |
Section 的具体内容如下：
节点名称（关键字） | 描述 | 类型 |
StartByte | 该分片位于文本中的起始位置信息（即10代表第11个utf8文字）。从0开始。 | Integer |
Label | 该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告，Illegal：违法，Abuse：谩骂。 | String |
Result | 该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。 | Integer |
PornInfo | 审核场景为涉黄的审核结果信息。 | Object |
AdsInfo | 审核场景为广告引导的审核结果信息。 | Object |
IllegalInfo | 审核场景为违法的审核结果信息。 | Object |
AbuseInfo | 审核场景为谩骂的审核结果信息。 | Object |
Section 中的 PornInfo，AdsInfo，IllegalInfo，AbuseInfo 的具体内容如下：
节点名称（关键字） | 描述 | 类型 |
HitFlag | 用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。 | Integer |
Score | 该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息。通常[0,60]分可以认为图片属于正常，[61,90]分表示图片疑似敏感，[91,100]分表示图片为敏感的。例如：色情 99，则表明该内容非常有可能属于色情内容。 | Integer |
Keywords | 在当前审核场景下命中的关键词，多关键词以 ,分割。 | String |
LibResults | 该字段用于返回基于风险库识别的结果。注意：未命中风险库中样本时，此字段不返回。 | Container Array |
SubLabel | 该字段表示审核命中的具体子标签，例如：Porn 下的 SexBehavior 子标签。注意：该字段可能返回空，表示未命中具体的子标签。 | String |
Container 节点 LibResults 的内容：
节点名称（关键字） | 描述 | 类型 |
LibType | 命中的风险库类型，取值为1（预设黑白库）和2（自定义风险库）。 | Integer |
LibName | 命中的风险库名称。 | String |
Keywords | 命中的库中关键词。该参数可能会有多个返回值，代表命中的多个关键词。 | String Array |
Container 节点 UserInfo 的内容：
节点名称（关键字） | 描述 | 类型 | 是否必选 |
TokenId | 一般用于表示账号信息，长度不超过128字节。 | String | 否 |
Nickname | 一般用于表示昵称信息，长度不超过128字节。 | String | 否 |
DeviceId | 一般用于表示设备信息，长度不超过128字节。 | String | 否 |
AppId | 一般用于表示 App 的唯一标识，长度不超过128字节。 | String | 否 |
Room | 一般用于表示房间号信息，长度不超过128字节。 | String | 否 |
IP | 一般用于表示 IP 地址信息，长度不超过128字节。 | String | 否 |
Type | 一般用于表示业务类型，长度不超过128字节。 | String | 否 |
ReceiveTokenId | 一般用于表示接收消息的用户账号，长度不超过128字节。 | String | 否 |
Gender | 一般用于表示性别信息，长度不超过128字节。 | String | 否 |
Level | 一般用于表示等级信息，长度不超过128字节。 | String | 否 |
Role | 一般用于表示角色信息，长度不超过128字节。 | String | 否 |
Container 节点 ListInfo 的内容：
节点名称（关键字） | 描述 | 类型 |
ListResults | 命中的所有名单结果。 | Container Array |
Container 节点 ListResults 的内容：
节点名称（关键字） | 描述 | 类型 |
ListType | 命中的名单类型，取值为0（白名单）和1（黑名单）。 | Integer |
ListName | 命中的名单名称。 | String |
Entity | 命中了名单中的哪条内容。 | String |
实际案例
案例一：简洁回调（Simple）
{"code": 0,"data": {"event":"ReviewText","forbidden_status": 0,"porn_info": {"hit_flag": 0,"label": "","count": 0},"result": 0,"trace_id": "ixzt90jl2dfscxxxxxxxxxxxxxxxxx","url": "https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.txt","cos_headers": {"x-cos-meta-id": "xxxxxx"}},"message": "success"}
案例二：详细回调（Detail）
{"EventName": "ReviewText","JobsDetail": {"JobId": "xxxxxx","State": "Success","CreationTime": "2021-08-10T21:01:08+08:00","Object": "1.txt","Label": "Normal","Result": 0,"SectionCount": 1,"PornInfo": {"HitFlag": 0,"Count": 0},"AdsInfo": {"HitFlag": 0,"Count": 0},"Section": [{"StartByte": 0,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""},"AdsInfo": {"HitFlag": 0,"Score": 0,"Keywords": ""}}],"BucketId": "examplebucket-1250000000","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "xxx"}}}
文档反馈