功能描述
若您配置了审核回调地址,在文档审核结束后,后台会将审核结果以 json 形式回调至您的回调地址。您可以通过回调内容,进行后续的文件处理操作。
![](https://qcloudimg.tencent-cloud.cn/image/document/32a59b98bbd22329206840123c38c5ba.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/32a59b98bbd22329206840123c38c5ba.png)
回调内容说明
该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:
{"EventName": "ReviewDocument","JobsDetail": {"JobId": "6666666666666666666666666666666666","State": "Success","CreationTime": "","Url": "","Label": "Normal","Suggestion": 0,"PageCount": 1,"Labels": {"PornInfo": {"HitFlag": 0,"Score": 0},"AdsInfo": {"HitFlag": 0,"Score": 0}},"PageSegment": {"Results": [{"Url": "","Text": "","PageNumber": 0,"SheetNumber": 0,"Label": "Normal","Suggestion": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"SubLabel": "","OcrResults": [{"Text": "","Keywords":["",""],"Location": {"X": 0,"Y": 0,"Width": 0,"Height": 0,"Rotate": 0}}]},"AdsInfo": {"HitFlag": 0,"Score": 0,"SubLabel": ""}}]},"BucketId": "examplebucket-1250000000","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "666666"}}}
具体的数据内容如下:
节点名称(关键字) | 描述 | 类型 |
JobsDetail | 任务的详细结果信息。 | Object |
EventName | 任务的类型,为 ReviewDocument 。 | String |
JobsDetail 的内容如下:
节点名称(关键字) | 描述 | 类型 |
Code | String | |
Message | 错误描述,只有 State 为 Failed 时返回。 | String |
JobId | 审核任务的 ID。 | String |
DataId | 提交任务时设置了 DataId 参数时返回,返回原始内容,长度限制为512字节。 | String |
State | 审核任务的状态,值为 Submitted(已提交审核)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个。 | String |
Label | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告。 | String |
Suggestion | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。 有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
CreationTime | 审核任务的创建时间。 | String |
Object | 审核的文件为存储在 COS 中的文件时,该字段表示本次审核的文件名称。 | String |
Url | 审核的文件链接,创建任务使用Url时返回。 | String |
PageCount | 文档审核会将文档转换为图片进行审核,该字段表示转换的图片总数量。 | Integer |
Labels | 该字段用于返回命中的审核场景及对应的结果。 | Object |
PageSegment | 文档转换为图片后,具体每张图片的审核结果信息。 | Object |
ForbidState | 若您设置了自动冻结,该字段表示文档的冻结状态。0:未冻结,1:已被冻结,2:已转移文件。 | Integer |
CosHeaders | 资源上传到 COS 时设置的自定义 Header 内容,如果未设置则不返回。map 结构,key 为自定义 Header 的名称,value 为内容。 | Object |
UserInfo | 用户业务字段。创建任务时未设置UserInfo则无此字段。 | Object |
ListInfo | 账号黑白名单结果。 | Container |
Labels 的内容如下:
节点名称(关键字) | 描述 | 类型 |
PornInfo | 审核场景为涉黄的审核结果信息。 | Object |
AdsInfo | 审核场景为广告引导的审核结果信息。 | Object |
Labels 中 PornInfo,AdsInfo 的内容如下:
节点名称(关键字) | 描述 | 类型 |
HitFlag | 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。 | Integer |
Score | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。例如:PornInfo 节点下 Score 返回99,表明该内容非常有可能属于色情内容。 | Integer |
PageSegment 的内容如下:
节点名称(关键字) | 描述 | 类型 |
Results | 文档转换为图片后,每张图片的详细审核结果信息。 | Array |
Results 的内容如下:
节点名称(关键字) | 描述 | 类型 |
Url | 文档转换成图片后,您可以通过该地址查看该图片内容,地址格式为标准 URL 格式。注意:每次查看数据的有效期为2小时,2小时后如还需查看,请重新发起查询请求。 | String |
Text | 该字段用于返回当前图片 OCR 文本识别的检测结果,仅在审核策略开启文本内容检测时返回。 | String |
PageNumber | 该图片的页码,通常是文档的页码。 | Integer |
SheetNumber | 如果审核的文档为表格文件,该字段表示表格内的 Sheet 页码。 | Integer |
Label | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。返回值:Normal:正常,Porn:色情,Ads:广告。 | String |
Suggestion | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
PornInfo | 审核场景为涉黄的审核结果信息。 | Object |
AdsInfo | 审核场景为广告引导的审核结果信息。 | Object |
Results 中 PornInfo,AdsInfo 的内容如下:
节点名称(关键字) | 描述 | 类型 |
HitFlag | 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。 | Integer |
Score | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。通常[0,60]分可以认为图片属于正常,[61,90]分表示图片疑似敏感,[91,100]分表示图片为敏感的。例如:PornInfo 节点下 Score 返回99,表明该内容非常有可能属于色情内容。 | Integer |
Category | 表示命中的具体审核类别。例如 Sexy,表示色情标签中的性感类别。该字段可能为空,表示未命中或暂无相关的类别。 | String |
SubLabel | 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。注意:该字段可能返回空,表示未命中具体的子标签。 | String |
OcrResults | 该字段表示 OCR 文本识别的详细检测结果,包括文本坐标信息、文本识别结果等信息,有相关违规内容时返回。 | Array |
LibResults | 该字段用于返回基于风险库识别的结果。注意:未命中风险库中样本时,此字段不返回。 | Container Array |
Container 节点 LibResults 的内容:
节点名称(关键字) | 描述 | 类型 |
ImageId | 该字段表示命中的风险库中的图片样本 ID。 | String |
Score | 该字段用于返回当前标签下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表当前的图片越有可能命中库中的样本。例如:PornInfo 节点下 Score 返回99,表明该内容非常有可能属于色情内容。 | Integer |
OcrResults 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
Text | 图片 OCR 文本识别出的具体文本内容。 | String |
Keywords | 在当前审核场景下命中的关键词。 | Array |
Location | 该参数用于返回 OCR 检测框在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位识别文字的相关信息。 | Object |
ObjectResults 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
Name | 该标签用于返回所识别出的实体名称,例如人名。 | String |
Location | 该参数用于返回检测结果在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位相关信息。 | Object |
Location 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
X | 该参数用于返回检测框左上角位置的横坐标(x)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Y | 该参数用于返回检测框左上角位置的纵坐标(y)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Height | 该参数用于返回检测框的高度(由左上角出发在 y 轴向下延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Width | 该参数用于返回检测框的宽度(由左上角出发在 x 轴向右延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Rotate | 该参数用于返回检测框的旋转角度,该参数结合 X 和 Y 两个坐标参数可唯一确定检测框的具体位置;取值:0-360(角度制),方向为逆时针旋转。 | Float |
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 |
实际案例
{"EventName": "ReviewDocument","JobsDetail": {"JobId": "xxxxxx","State": "Success","CreationTime": "2021-08-10T21:01:10+08:00","Url": "http://test.com/test.doc","Label": "Normal","Suggestion": 0,"PageCount": 1,"Labels": {"PornInfo": {"HitFlag": 0,"Score": 0},"AdsInfo": {"HitFlag": 0,"Score": 0}},"PageSegment": {"Results": [{"Url": "http://audit-125000000.cos.ap-chongqing.myqcloud.com/1.jpg","Text": "","PageNumber": 1,"SheetNumber": 0,"Label": "Normal","Suggestion": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"SubLabel": ""},"AdsInfo": {"HitFlag": 0,"Score": 0,"SubLabel": ""}}]},"BucketId": "examplebucket-1250000000","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "xxxx"}}}