功能描述
若您配置了审核回调地址,在文档审核结束后,后台会将审核结果以 json 形式回调至您的回调地址。您可以通过回调内容,进行后续的文件处理操作。
回调内容说明
该响应体返回为 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 | 错误描述,当 code 为0时该字段无内容。 | String |
JobId | 审核任务的 ID。 | String |
State | 审核任务的状态,值为 Submitted(已提交审核)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个。 | String |
Label | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告。 | String |
Suggestion | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。 有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
CreationTime | 审核任务的创建时间。 | String |
Url | 审核的文件链接。 | String |
PageCount | 文档审核会将文档转换为图片进行审核,该字段表示转换的图片总数量。 | Integer |
Labels | 该字段用于返回命中的审核场景及对应的结果。 | Object |
PageSegment | 文档转换为图片后,具体每张图片的审核结果信息,只返回带有违规结果的图片。 | Object |
Labels 的内容如下:
节点名称(关键字) | 描述 | 类型 |
PornInfo | 审核场景为涉黄的审核结果信息。 | Object |
AdsInfo | 审核场景为广告引导的审核结果信息。 | Object |
Labels 中 PornInfo,AdsInfo 的内容如下:
节点名称(关键字) | 描述 | 类型 |
HitFlag | 供参考的识别结果,0(正常),1(敏感),2(疑似敏感)。 | Integer |
Score | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息 例如:色情 99,则表明该内容非常有可能属于色情内容。 | Integer |
PageSegment 的内容如下:
节点名称(关键字) | 描述 | 类型 |
Results | 文档转换为图片后,每张图片的详细审核结果信息。 | Array |
Results 的内容如下:
节点名称(关键字) | 描述 | 类型 |
Url | 文档转换成图片后,该张图片的 Url。 | String |
Text | 文档审核会使用 OCR 方式进行审核,该字段表示图片 OCR 文本识别出的全部文本内容,识别上限在5000字节内。 | 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]分可以认为图片属于正常,(60,90]分表示图片疑似敏感,(90,100]分表示图片为敏感的。 例如:色情 99,则表明该内容非常有可能属于色情内容。 | Integer |
SubLabel | 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。 注意:该字段可能返回空,表示未命中具体的子标签。 | String |
OcrResults | 该字段表示 OCR 文本识别的详细检测结果,包括文本坐标信息、文本识别结果等信息。 | Object |
OcrResults 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
Text | 图片 OCR 文本识别出的具体文本内容。 | String |
Keywords | 在当前审核场景下命中的关键词。 | Array |
Location | 该参数用于返回 OCR 检测框在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位识别文字的相关信息。 | Object |
ObjectResults 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
Name | 该标签用于返回所识别出的实体名称,例如人名。 注意:此字段可能返回 null,表示取不到有效值。 | String |
Location 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
X | 该参数用于返回检测框左上角位置的横坐标(x)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Integer |
Y | 该参数用于返回检测框左上角位置的纵坐标(y)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Integer |
Height | 该参数用于返回检测框的高度(由左上角出发在 y 轴向下延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Integer |
Width | 该参数用于返回检测框的宽度(由左上角出发在 x 轴向右延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Integer |
Rotate | 该参数用于返回检测框的旋转角度,该参数结合 X 和 Y 两个坐标参数可唯一确定检测框的具体位置;取值:0-360(角度制),方向为逆时针旋转。 | Integer |
实际案例
{"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"}}}