功能描述
本接口用于主动查询指定的视频审核任务结果。视频审核功能为异步任务方式,您可以通过提交视频审核任务审核您的视频文件,然后通过查询视频审核任务接口查询审核结果。
说明:
视频审核任务结果保存时效为1个月,您可通过本接口查询近1个月的审核结果。
授权说明
服务开通
使用限制
推荐使用 SDK
请求
请求示例
GET /video/auditing/<jobId> HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
说明
请求头
请求体
该请求无请求体。
请求参数
参数名称 | 描述 | 类型 | 是否必选 |
jobId | 要查询的任务ID,可通过提交审核任务的响应中获取。 | String | 是 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code>Success</Code><Message>Success</Message><DataId></DataId><JobId></JobId><State></State><CreationTime></CreationTime><Object></Object><SnapshotCount></SnapshotCount><Label></Label><Result>1</Result><PornInfo><HitFlag></HitFlag><Count></Count></PornInfo><AdsInfo><HitFlag></HitFlag><Count></Count></AdsInfo><Snapshot><Url></Url><Text></Text><SnapshotTime></SnapshotTime><PornInfo><HitFlag></HitFlag><Score></Score><Label></Label><SubLabel></SubLabel></PornInfo><AdsInfo><HitFlag></HitFlag><Score></Score><Label></Label><SubLabel></SubLabel></AdsInfo></Snapshot><AudioSection><Url></Url><OffsetTime>0</OffsetTime><Duration>3000</Duration><Text>哈哈哈</Text><PornInfo><HitFlag></HitFlag><Score></Score><Keywords></Keywords></PornInfo><AdsInfo><HitFlag></HitFlag><Score></Score><Keywords></Keywords></AdsInfo></AudioSection></JobsDetail><RequestId></RequestId></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 视频审核的全部结果信息。 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 视频审核任务的详细信息。 | Container |
RequestId | Response | 每次请求发送时,服务端将会自动为请求生成一个 ID,遇到问题时,该 ID 能更快地协助定位问题。 | String |
Container 节点 JobsDetail 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | String | |
Message | Response.JobsDetail | 错误描述,只有 State 为 Failed 时返回。 | String |
DataId | Response.JobsDetail | 提交任务时设置了 DataId 参数时返回,返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 | String |
JobId | Response.JobsDetail | 视频审核任务的 ID。 | String |
State | Response.JobsDetail | 视频审核任务的状态,值为 Submitted(已提交审核)、Snapshoting(视频截帧中)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个。 | String |
CreationTime | Response.JobsDetail | 视频审核任务的创建时间。 | String |
Object | Response.JobsDetail | 本次审核的文件名称,创建任务使用 Object 时返回。 | String |
Url | Response.JobsDetail | 本次审核的文件链接,创建任务使用 Url 时返回。 | String |
SnapshotCount | Response.JobsDetail | 视频截图的总数量。 | String |
Label | Response.JobsDetail | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 | String |
Result | Response.JobsDetail | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
PornInfo | Response.JobsDetail | 审核场景为色情的审核结果信息。 | Container |
AdsInfo | Response.JobsDetail | 审核场景为广告的审核结果信息。 | Container |
Snapshot | Response.JobsDetail | 该字段用于返回视频中视频画面截图审核的结果。 | Container Array |
AudioSection | Response.JobsDetail | 该字段用于返回视频中视频声音审核的结果。如果未检测音频,则不返回。 | Container Array |
UserInfo | Response.JobsDetail | 用户业务字段。创建任务未设置 UserInfo 时无此字段。 | Container |
ListInfo | Response.JobsDetail | 如果审核结果命中了业务字段风险库,将返回该字段。 | Container |
ForbidState | Response.JobsDetail | 若您设置了自动冻结,该字段表示图片的冻结状态。0:未冻结,1:已被冻结,2:已转移文件。 | Integer |
Container 节点 PornInfo,AdsInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
HitFlag | Response.JobsDetail.*Info | 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。 | Integer |
Count | Response.JobsDetail.*Info | 命中该审核分类的截图张数。 | Integer |
Score | Response.JobsDetail.*Info | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高),越高代表该内容越有可能属于当前返回的审核信息。 例如:色情 99,则表明该内容非常有可能属于色情内容。 | Integer |
Container 节点 Snapshot 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Url | Response.JobsDetail.Snapshot | 视频截图的访问地址,您可以通过该地址查看该截图内容,地址格式为标准 URL 格式。注意:每次查看数据的有效期为2小时,2小时后如还需查看,请重新发起查询请求。 | String |
SnapshotTime | Response.JobsDetail.Snapshot | 该字段用于返回当前截图位于视频中的时间,单位为毫秒。例如5000(视频开始后5000毫秒)。审核直播流时,该字段返回当前截图的时间戳,单位为毫秒。例如1649387157000。 | Integer |
Text | Response.JobsDetail.Snapshot | 该字段用于返回当前截图的图片 OCR 文本识别的检测结果,仅在审核策略开启文本内容检测时返回。 | String |
Label | Response.JobsDetail.AudioSection | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 | String |
SubLabel | Response.JobsDetail.AudioSection | 该字段表示审核命中的具体子标签。注意:该字段可能返回空。 | String |
Result | Response.JobsDetail.AudioSection | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
PornInfo | Response.JobsDetail.Snapshot | 审核场景为色情的审核结果信息。 | Container |
AdsInfo | Response.JobsDetail.Snapshot | 审核场景为广告的审核结果信息。 | Container |
Container 节点 PornInfo,AdsInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
HitFlag | Response.JobsDetail.Snapshot.*Info | 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。 | Integer |
Score | Response.JobsDetail.Snapshot.*Info | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回的审核信息。例如:色情 99,则表明该内容非常有可能属于色情内容。 | Integer |
Label | Response.JobsDetail.Snapshot.*Info | 该字段表示该截图的综合结果标签(可能为 SubLabel,可能为人物名字等)。 | String |
Category | Response.JobsDetail.Snapshot.*Info | 该字段为 Label 的子集,表示审核命中的具体审核类别。例如 Sexy,表示色情标签中的性感类别。 | String |
SubLabel | Response.JobsDetail.Snapshot.*Info | 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。注意:该字段可能返回空,表示未命中具体的子标签。 | String |
OcrResults | Response.JobsDetail.Snapshot.*Info | 该字段表示 OCR 文本识别的详细检测结果,包括文本坐标信息、文本识别结果等信息,有相关违规内容时返回。 | Container Array |
LibResults | Response.JobsDetail.Snapshot.*Info | 该字段用于返回基于风险库识别的结果。注意:未命中风险库中样本时,此字段不返回。 | Container Array |
Container 节点 LibResults 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
ImageId | Response.JobsDetail.Snapshot.*Info.LibResults | 该字段表示命中的风险库中的图片样本 ID。 | String |
Score | Response.JobsDetail.Snapshot.*Info.LibResults | 该字段用于返回当前标签下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表当前的图片越有可能命中库中的样本;如:色情 99,则表明该数据非常有可能命中库中的色情样本。 | Integer |
OcrResults 的具体内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Text | Response.JobsDetail.Snapshot.*Info.OcrResults | 图片 OCR 文本识别出的具体文本内容。 | String |
Keywords | Response.JobsDetail.Snapshot.*Info.OcrResults | 在当前审核场景下命中的关键词。 | String Array |
Location | Response.JobsDetail.Snapshot.*Info.OcrResults | 该参数用于返回 OCR 检测框在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位识别文字的相关信息。 | Container |
ObjectResults 的具体内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | Response.JobsDetail.Snapshot.*Info.ObjectResults | 该标签用于返回所识别出的实体名称,例如人名。 | String |
SubLabel | Response.JobsDetail.Snapshot.*Info.ObjectResults | 该字段表示审核命中的具体子标签。注意:该字段可能返回空。 | String |
Location | Response.JobsDetail.Snapshot.*Info.ObjectResults | 该参数用于返回检测结果在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位相关信息。 | Container |
Location 的具体内容如下:
节点名称(关键字) | 描述 | 类型 |
X | 该参数用于返回检测框左上角位置的横坐标(x)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Y | 该参数用于返回检测框左上角位置的纵坐标(y)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Height | 该参数用于返回检测框的高度(由左上角出发在 y 轴向下延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Width | 该参数用于返回检测框的宽度(由左上角出发在 x 轴向右延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 | Float |
Rotate | 该参数用于返回检测框的旋转角度,该参数结合 X 和 Y 两个坐标参数可唯一确定检测框的具体位置;取值:0-360(角度制),方向为逆时针旋转。 | Float |
Container 节点 AudioSection 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Url | Response.JobsDetail.AudioSection | 视频声音片段的访问地址,您可以通过该地址获取该声音片段的内容,地址格式为标准 URL 格式。注意:每次查看数据的有效期为2小时,2小时后如还需查看,请重新发起查询请求。 | String |
Text | Response.JobsDetail.AudioSection | 该字段用于返回当前视频声音的 ASR 文本识别的检测结果。 | String |
OffsetTime | Response.JobsDetail.AudioSection | 该字段用于返回当前声音片段位于视频中的时间,单位为毫秒,例如5000(视频开始后5000毫秒)。审核直播流时,该字段返回当前声音片段的时间戳,单位为毫秒,例如1649387157000。 | Integer |
Duration | Response.JobsDetail.AudioSection | 当前视频声音片段的时长,单位毫秒。 | Integer |
Label | Response.JobsDetail.AudioSection | 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 | String |
SubLabel | Response.JobsDetail.AudioSection | 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。注意:该字段可能返回空,表示未命中具体的子标签。 | String |
Result | Response.JobsDetail.AudioSection | 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 | Integer |
PornInfo | Response.JobsDetail.AudioSection | 审核场景为色情的审核结果信息。 | Container |
AdsInfo | Response.JobsDetail.AudioSection | 审核场景为广告的审核结果信息。 | Container |
Container 节点 PornInfo,AdsInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
HitFlag | Response.JobsDetail.AudioSection.*Info | 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。 | String |
Score | Response.JobsDetail.AudioSection.*Info | 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息例如:色情 99,则表明该内容非常有可能属于色情内容。 | String |
Category | Response.JobsDetail.AudioSection.*Info | 该字段为 Label 的子集,表示审核命中的具体审核类别。例如 Sexy,表示色情标签中的性感类别。 | String |
SubLabel | Response.JobsDetail.AudioSection.*Info | 该字段表示审核命中的具体子标签。注意:该字段可能返回空。 | String |
Keywords | Response.JobsDetail.AudioSection.*Info | 在当前审核场景下命中的关键词,没有时不返回 | String Array |
LibResults | Response.JobsDetail.AudioSection.*Info | 该字段用于返回基于风险库识别的结果。注意:未命中风险库中样本时,此字段不返回。 | Container Array |
Container 节点 LibResults 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
LibType | Response.JobsDetail.AudioSection.*Info.LibResults | 命中的风险库类型,取值为1(预设黑白库)和2(自定义风险库)。 | Integer |
LibName | Response.JobsDetail.AudioSection.*Info.LibResults | 命中的风险库名称。 | String |
Keywords | Response.JobsDetail.AudioSection.*Info.LibResults | 命中的库中关键词。该参数可能会有多个返回值,代表命中的多个关键词。 | 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 | Response.JobsDetail.ListInfo | 命中的所有业务字段风险库结果。 | Container Array |
Container 节点 ListResults 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
ListType | Response.JobsDetail.ListInfo.ListResults | 命中的业务字段风险库类型,取值为0(白库)和1(黑库)。 | Integer |
ListName | Response.JobsDetail.ListInfo.ListResults | 命中的业务字段风险库名称。 | String |
Entity | Response.JobsDetail.ListInfo.ListResults | 命中了业务字段风险库中的哪条内容。 | String |
错误码
实际案例
请求
GET /video/auditing/vab1ca9fc8a3ed11ea834c525400863904 HTTP/1.1Accept: */*Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 666Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><JobId>vab1ca9fc8a3ed11ea834c525400863904</JobId><State>Success</State><CreationTime>2019-07-07T12:12:12+0800</CreationTime><Object>a.mp4</Object><SnapshotCount>1</SnapshotCount><Label>Normal</Label><Result>0</Result><PornInfo><HitFlag>0</HitFlag><Count>0</Count></PornInfo><AdsInfo><HitFlag>0</HitFlag><Count>0</Count></AdsInfo><Snapshot><Url>http://examplebucket-1250000000.cos.ap-chongqing.myqcloud.com/0.jpg</Url><SnapshotTime>0</SnapshotTime><Text>哈哈</Text><Label>Normal</Label><Result>0</Result><PornInfo><HitFlag>0</HitFlag><Score>0</Score><Label></Label><SubLabel></SubLabel></PornInfo><AdsInfo><HitFlag>0</HitFlag><Score>0</Score><Label></Label><SubLabel></SubLabel></AdsInfo></Snapshot><AudioSection><AdsInfo><HitFlag>0</HitFlag><Score>0</Score></AdsInfo><Duration>30000</Duration><OffsetTime>0</OffsetTime><Label>Normal</Label><Result>0</Result><PornInfo><HitFlag>0</HitFlag><Score>0</Score></PornInfo><Text>wc xx</Text><Url>https://auditing-1250000000.cos.ap-guangzhou.myqcloud.com/q9MhdztF/0.mp3</Url></AudioSection></JobsDetail><RequestId>xxxxxxxxxxxxxx</RequestId></Response>