功能描述
若您配置了审核回调地址,在文本审核结束后,后台会将审核结果以 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 | 错误码,值为0时表示审核成功,非0表示审核失败。详情请查看 内容审核错误码。 | Int | 是 |
message | 错误描述,当 code 为0时该字段无内容。 | String | 是 |
data | 图片审核结果的详细信息。 | json | 是 |
data的具体内容如下:
参数名称 | 描述 | 类型 | 是否必选 |
---|---|---|---|
trace_id | 唯一 ID 标识。如果是通过接口创建的异步任务,则为接口返回的 JobId。 | String | 是 |
url | 被审核文本的完整 URL 链接。 | String | 是 |
event | 触发的事件,此处固定为 ReviewText。 | String | 是 |
result | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。 有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 |
Int | 是 |
forbidden_status | 若您设置了自动冻结,该字段表示视频的冻结状态。0:未冻结,1:已被冻结。 | Int | 是 |
cos_headers | 资源上传时设置的自定义 header 内容,若未设置则不返回。 | json | 否 |
porn_info | 审核场景为涉黄的审核结果信息。 | json | 否 |
ads_info | 审核场景为广告引导的审核结果信息。 | json | 否 |
abuse_info | 审核场景为谩骂的审核结果信息。 | json | 否 |
illegal_info | 审核场景为违法的审核结果信息。 | json | 否 |
xx_info 的具体内容如下:
参数名称 | 描述 | 类型 | 是否必选 |
---|---|---|---|
hit_flag | 是否命中该审核分类,0表示未命中,1表示命中,2表示疑似。 | Int | 是 |
label | 命中的关键字。 | String | 是 |
count | 命中该审核分类的敏感文本段数。 | Int | 是 |
详细回调(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 | 错误码,值为0时表示审核成功,非0表示审核失败。详情请查看 内容审核错误码。 | String |
Message | 错误描述,当 code 为0时该字段无内容。 | String |
JobId | 本次文本审核任务的 ID。 | 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 |
Section | 文本内容每一段的审核结果。 | Array |
BucketId | 创建的审核任务所属的存储桶名称。 | String |
Region | 存储桶所在的地域。 | String |
ForbidState | 若您设置了自动冻结,该字段表示视频的冻结状态。0:未冻结,1:已被冻结。 | Integer |
CosHeaders | 资源上传到 COS 时设置的自定义 Header 内容,如果未设置则不返回。map 结构,key 为自定义 Header 的名称,value 为内容。 | Object |
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]分可以认为图片属于正常,(60,90]分表示图片疑似敏感,(90,100]分表示图片为敏感的。 例如:色情 99,则表明该内容非常有可能属于色情内容。 |
Integer |
Keywords | 在当前审核场景下命中的关键词。 | 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"
}
}
}