控制台指南

最佳实践

开发者指南

数据湖存储

API 文档

SDK 文档

文档捉虫大赛火热进行中,好礼多多> HOT

简介

内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。

说明:

使用内容审核服务需拥有数据万象使用权限:

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

注意:

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

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

提交网页审核任务

功能说明

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

示例代码

    """测试ci网页文件内容审核的接口"""
    # 先创建 cos client
    # 识别cos上的网页
    response= client.ci_auditing_html_submit(
        Bucket='bucket',
        DetectType=CiDetectType.PORN | CiDetectType.ADS,
        Url='http://example.com'
    )
    print response

参数说明

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

参数名称 描述 类型 是否必选
Bucket 存储桶名称。 String
Url 网页路径。 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
ReturnHighlightHtml 指定是否需要高亮展示网页内的违规文本,查询及回调结果时会根据此参数决定是否返回高亮展示的 html 内容。取值为 true 或者 false,默认为 false。 Bool
UserInfo 用户业务字段。可传入的参数请参考 提交网页审核任务 的 UserInfo 字段。 Dict
DataId 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 String

返回参数说明

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

查询网页审核任务结果

功能说明

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

示例代码

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

参数说明

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

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

返回参数说明

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

目录