5.1 视频 OCR
5.1.3 查询单个作业
● 参数说明
名称 是否必选 类型 说明
project_id 是 String 项目ID。获取方法请参见
获取项目ID。
task_id 是 String 作业ID。
请求消息
请求示例GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks/
f18320e61e4c4dc685aa2dfc22a28dc5
taskDetail Object 作业详情，定义见task.detail（作业
详情参数）。
返回值
● 正常 200
API 参考 5 视频内容分析 API
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
5.1.4 删除作业
功能介绍
该API用于删除指定作业。
URI
● URI格式
DELETE /v2/{project_id}/services/video-ocr/tasks/{task_id}
● 参数说明
名称 是否必选 类型 说明
project_id 是 String 项目ID。
task_id 是 String 作业ID。
请求消息
请求示例DELETE /v2/6204a5bd270343b5885144cf9c8c158d/services/video-ocr/tasks/
f18320e61e4c4dc685aa2dfc22a28dc5
响应消息
● 删除失败时的响应示例
{ "error_code": "IVA.0005",
"error_msg": "The requested resource is NOT found. The taskId f18320e61e4c4dc685aa2dfc22a28dc5 is not found."
}
● 响应参数说明
参数名称 描述信息
error_code 错误码。具体请参考错误码。
API 参考 5 视频内容分析 API
参数名称 描述信息
error_msg 错误信息。
返回值
● 正常
输出类型是hosting时返回202，其它都返回200。
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
API 参考 5 视频内容分析 API
6 视频内容审核
6.1 创建作业
功能介绍
该接口用于创建视频内容审核的作业。
URI
● URI格式
POST /v2/{project_id}/services/video-moderation/tasks
● 参数说明 名称 是
否 必 选
类型 说明
project
_id 是 Strin
g 服务所在区域对应的项目ID，获取方法请参见获取项目
ID。
请求消息
● 示例
POST /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks {
"name": "task-test", "description": "description", "input": {
"type": "obs", "data": [ {
"bucket": "obs-iva", "index": 0,
"path": "input/demo.mp4"
} ] },
"output": {
API 参考 6 视频内容审核
"obs": {
description 否 String 作业描述信息，最大长度为500 字符长度。
output 是 Object 结果数据的输出列表，目前只支
持以下输出类型：
名称 是否必选 类型 说明
service_config 否 Object 服务算法配置，字段结构跟服务 相关，目前配置项为common，
详细参数定义参见
serviceConfig.common字段结 构...。
service_version 是 String 功能版本为“1.2”。
● service_config.common字段结构说明
参数 是否必选 类型 说明
use_sis 否 String 是否使用语音审核服务。
● true：使用
● false：不使用
当不设置该参数或参数为空时，默认为不使用。
use_oc
r 否 String 是否使用文字审核服务。
● true：使用
● false：不使用
当不设置该参数或参数为空时，默认为不使用。
upload 否 String 是否使用问题场景图片上传服务。
● true：使用
● false：不使用
当不设置该参数或参数为空时，默认为不使用。
当使用该服务时，必须设置obs输出目录，否则图 片无法上传。问题图片会自动上传至输出路径/
task_id目录下。
响应消息
● 响应示例
[ { "id": "f18320e61e4c4dc685aa2dfc22a28dc5" } ]
● 返回作业ID列表
参数名称 类型 描述信息
id String 作业ID。
返回值
● 正常 201
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
API 参考 6 视频内容审核
返回值 说明
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
6.2 查询作业列表
project_id 是 String 项目ID。获取方法请参见获取
项目ID。
"id": "f18320e61e4c4dc685aa2dfc22a28dc5", "name": "moderation-task",
"description": "description", "input": {
"service_config": { "common": {
"categories": "porn", "frame_interval": 5,
"text_categories": "porn,politics", "upload": "false",
"use_ocr": "true", "use_sis": "true"
} },
"service_version": "1.2", "state": "RUNNING",
"created_at": "2018-06-12T13:00:00Z", "updated_at": "2018-06-13T13:00:01Z"
} ]}
● 响应参数说明
参数名称 类型 描述信息
tasks Array of
taskDetail 作业详情，定义见task.detail（作业
详情参数）。
count Integer 符合查询条件的总条目数。
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。
6.3 查询单个作业
功能介绍
该API用于查询并显示单个作业详情。
API 参考 6 视频内容审核
URI
● URI格式
GET /v2/{project_id}/services/video-moderation/tasks/{task_id}
● 参数说明
名称 是否必选 类型 说明
project_id 是 String 项目ID。获取方法请参见获取项目
ID。
task_id 是 String 作业ID。
请求消息
请求示例GET /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks/
f18320e61e4c4dc685aa2dfc22a28dc5
响应消息
● 响应示例
{ "description": "description", "service_version": "1.2", "output": {
"result_json_overdue_at": "2019-03-01T10:32:32Z"
}
"created_at": "2019-03-01T10:32:12Z", "service_config": {
"common": {
"name": "video-moderation-2",
"id": "f18320e61e4c4dc685aa2dfc22a28dc5",
API 参考 6 视频内容审核
"state": "SUCCEEDED", "hosting_result": {
"overdueDate": "2019-03-28T10:32:32Z",
"data": "{\"result\": {\"frames\": [{\"detail\": {\"ad\": [{\"confidence\": 0,\"label\": \"ad\"}, {\"confidence\": 1,\"label\": \"normal\"}],\"ocr_ad\": [{\"text\": \"抢答器\"}]},\"frame_begin\":
92.0,\"frame_end\": 93.0,\"frame_img_path\": \"taskrd16xsvl/92_ad.jpg\",\"frame_suggestion\": \"block
\",\"suspect_categories\": [\"ocr_ad\"]}],\"suggestion\": \"block\",\"voices\": [{\"content\": \"这个反应的 抢答器，啊那么他身体上的一些不方便呢不会受到这个影响。好，请科学助理为两位戴上防干扰耳机，啊 我不需要而且我觉得戴的不舒服，OK啊其实不戴耳机对我来说没有太大的干扰，我的注意力非常非常集 中，除了屏幕上的这个摄像图和数字之外，我其他的看不到也听不到。\",\"detail\": {\"ad\": [\"抢答器\"]},
\"voice_begin\": 92.24,\"voice_end\": 117.62,\"voice_suggestion\": \"block\"}]},\"video_path\": \"input/
demo.mp4\"}",
"fileSize": "329 bytes", "status": "AVAILABLE"
},
"updated_at": "2019-03-02T10:32:34Z"
}
● 响应参数说明
参数名称 类型 描述信息
taskDetail Object 作业详情，定义见task.detail（作业
详情参数）。
结果说明
视频内容审核结果在用户输入的output路径下，以json文件的方式保存。
● 结果文件内容示例
{ "video_path": "demo.mp4", "result": {
"detail": { "ad": [ "抢答器"
] },
"voice_begin": 92.24, "voice_end": 117.62, "voice_suggestion": "block"
} ],
"suggestion": "block"
} }
● 结果文件的字段说明
参数名称 描述信息
video_path 视频路径。
result 视频处理结果。
● result字段说明
参数名称 描述信息
suggestion 视频处理建议。
● review：建议人工复查。
● block：建议封禁。
● pass：审核通过。
voices Json数组，表示语音场景问题详情，详细参数定义参见
•语音场景问题片段具体字段含义。
当没有语音场景问题帧时，该数组显示为空。
frames Json数组，表示视频问题帧详情，详细参数定义参见•
视频场景问题帧具体字段含义。
当没有视频问题帧时，该数组显示为空。
● 语音场景问题片段具体字段含义
参数名称 描述信息
voice_begin 起始时间。
voice_end 结束时间。
content 语音文本内容。
detail 该片段具体情况，politics为涉政检测结果，porn为涉 黄检测结果。具体字段含义参考文本内容检测API文 档。
API 参考 6 视频内容审核
参数名称 描述信息
voice_suggestion 该片段处理建议。
● review：建议人工复查。
● block：建议禁止。
● 视频场景问题帧具体字段含义
参数名称 描述信息
frame_begin 起始帧位置。
单位：秒。
frame_end 结束帧位置。
单位：秒。
suspect_categories 该帧可疑的场景，其中有ocr前缀的为图片转文字后的 审核结果。
frame_img_path 当该帧的frame_suggestion为review或者block时，并 且创建视频作业时upload配置为true，会将当前帧作为 图片保存到OBS上， frame_img_path表示图片的OBS 保存地址。
detail 该帧具体情况，politics为涉政检测结果，terrorism为 暴恐检测结果，porn为涉黄检测结果。具体字段含义 参考图像内容检测API文档以及上述的文本内容审核API 文档。
frame_suggestion 该帧处理建议。
● review：建议人工复查。
● block：建议禁止。
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
API 参考 6 视频内容审核
返回值 说明
503 Service Unavailable 服务不可用。
6.4 删除作业
功能介绍
该API用于删除指定作业。
URI
● URI格式
DELETE /v2/{project_id}/services/video-moderation/tasks/{task_id}
● 参数说明
名称 是否必选 类型 说明
project_
id 是 String 项目ID。获取方法请参见获取项目
ID。
task_id 是 String 作业ID。
请求消息
请求示例DELETE /v2/6204a5bd270343b5885144cf9c8c158d/services/video-moderation/tasks/
f18320e61e4c4dc685aa2dfc22a28dc5
响应消息
● 删除失败时的响应示例
{ "error_code": "IVA.0005",
"error_msg": "The requested resource is NOT found. The taskId f18320e61e4c4dc685aa2dfc22a28dc5 is not found."
}
● 响应参数说明
参数名称 描述信息
error_code 错误码。具体请参考错误码。
error_msg 错误信息。
返回值
● 正常
输出类型是hosting时返回202，其它都返回200。
API 参考 6 视频内容审核
● 异常
返回值 说明
400 Bad Request 请求错误，具体返回错误码请参考错误
码。
401 Unauthorized 鉴权失败。
403 Forbidden 没有操作权限。
404 Not Found 找不到资源。
500 Internal Server Error 服务内部错误。
503 Service Unavailable 服务不可用。