控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

简介

本文档提供视频审核相关的 API 概览以及 SDK 示例代码。

注意:

该功能需要 COS Python SDK v5.1.9.10 及以上版本。旧版本可能存在 bug,使用时建议升级到 最新版本

API 操作描述
提交视频审核任务 用于提交一个视频审核任务。
查询视频审核任务结果 用来查询指定的视频审核任务。

提交视频审核任务

功能说明

本接口用于提交一个视频审核任务。视频审核功能为异步任务方式,您可以通过提交视频审核任务来审核您的视频文件,然后通过查询视频审核任务接口查询审核结果。

示例代码

    """测试ci视频文件内容审核的接口"""
    # 先创建 cos client
    # 识别cos上的视频
    response = client.ci_auditing_video_submit(
        Bucket='bucket',
        DetectType=CiDetectType.PORN | CiDetectType.ADS,
        Key='test.mp4'
    )
    print response

参数说明

调用 ci_auditing_video_submit 函数,具体请求参数如下:

参数名称 描述 类型 是否必选
Bucket 存储桶名称。 String
Key 对象文件名,例如 picture.jpg。 String
BizType 表示审核策略的唯一标识,您可以通过控制台上的审核策略页面,配置您希望审核的场景,如涉黄、广告、违法违规等,配置指引: 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时,此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时,将自动使用默认的审核策略。 String
DetectType 审核类型,支持 CiDetectType.PORN(涉黄识别)、CiDetectType.ADS(广告识别),用户可选择多种识别类型,例如 CiDetectType.PORN \| CiDetectType.ADS 表示对视频进行涉黄和广告识别审核。如果您有更多的审核场景需要,请使用 BizType 参数。 enum
Url 支持直接使用非 COS 上的视频 url 进行审核。 String
Callback 回调地址,以 http:// 或者 https:// 开头的地址。 String
CallbackVersion 回调内容的结构,有效值:Simple(回调内容包含基本信息)、Detail(回调内容包含详细信息)。默认为 Simple。 String
Mode 截帧模式。Interval 表示间隔模式;Average 表示平均模式;Fps 表示固定帧率模式。
  • Interval 模式:TimeInterval,Count 参数生效。当设置 Count,未设置 TimeInterval 时,表示截取所有帧,共 Count 张图片。
  • Average 模式:Count 参数生效。表示整个视频,按平均间隔截取共 Count 张图片。
  • Fps 模式:TimeInterval 表示每秒截取多少帧,Count 表示共截取多少帧
  • String
    Count 视频截帧数量,范围为(0, 10000]。 String
    TimeInterval 视频截帧频率,范围为(0, 60],单位为秒,支持 float 格式,执行精度精确到毫秒。 String
    UserInfo 用户业务字段。可传入的参数请参考 提交视频审核任务 的 UserInfo 字段。 Dict
    DataId 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 String

    返回参数说明

    调用 ci_auditing_video_submit 函数,会把 api 里面的 xml 返回转换成 dict,具体返回参数可查看 提交视频审核任务 文档。

    查询视频审核任务的结果

    功能说明

    本接口用于主动查询指定的视频审核任务结果。视频审核功能为异步任务方式,您可以通过提交视频审核任务来审核您的视频文件,然后通过查询视频审核任务接口查询审核结果。

    示例代码

        """测试ci查询审核任务结果的接口"""
        # 先创建 cos client
        # 查询审核的结果
        response = client.ci_auditing_video_query(
            Bucket='bucket',
            JobID='v11122zxxxazzz'
        )
        print response

    参数说明

    调用 ci_auditing_video_query 函数,具体请求参数如下:

    参数名称 描述 类型 是否必选
    Bucket 存储桶名称。 String
    JobID 任务 ID。 String

    返回参数说明

    调用 ci_auditing_video_query 函数,会把 api 里面的 xml 返回转换成 dict,具体返回参数可查看 查询视频审核任务结果 文档。

    目录