tencent cloud

文档反馈

网页审核

最后更新时间:2024-01-04 18:00:58

    简介

    内容审核功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
    说明
    使用内容审核服务需拥有数据万象使用权限:
    主账号请 单击此处 进行角色授权。
    子账号请参见 授权子账号接入数据万象服务 文档。
    本文档提供关于网页审核的 API 概览和 SDK 示例代码。
    API
    操作描述
    用于提交一个网页审核任务
    用于查询指定的网页审核任务

    提交网页审核任务

    功能说明

    用于提交一个网页审核任务。

    方法原型

    CosResult CosAPI::CreateWebPageAuditingJob(const CreateWebPageAuditingJobReq& req, CreateWebPageAuditingJobResp* resp);

    请求示例

    qcloud_cos::CosConfig config("./config.json");
    qcloud_cos::CosAPI cos(config);
    std::string bucket_name = "examplebucket-1250000000";
    std::string url = "http://test.com";
    
    CreateWebPageAuditingJobReq req(bucket_name);
    CreateWebPageAuditingJobResp resp;
    
    // 添加请求参数 参数详情请见api接口文档
    req.SetUrl(url);
    req.SetDetectType("Porn,Ads");
    
    // 调用接口,获取任务响应对象
    CosResult result = cos.CreateWebPageAuditingJob(req, &resp);
    if (result.IsSucc()) {
    // 创建审核任务成功,可以调用 CreateWebPageAuditingJobResp 的成员函数
    } else {
    // 创建审核任务失败,可以调用 CosResult 的成员函数输出错误信息
    }

    参数说明

    参数
    参数描述
    类型
    是否必填
    req
    CreateWebPageAuditing 操作的请求
    CreateWebPageAuditingJobReq
    resp
    CreateWebPageAuditing 操作的响应
    CreateWebPageAuditingJobResp
    CreateWebPageAuditingJobReq 提供以下成员函数:
    // 设置执行操作的bucket
    void SetBucketName(const std::string& bucket_name);
    // 设置input需要审核的视频
    void SetInput(const AuditingInput& input);
    // 设置审核配置规则
    void SetConf(const Conf& conf);
    
    // conf
    // 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads。
    void SetDetectType(const std::string& detect_type);
    // 回调地址,以http://或者https://开头的地址。
    void SetCallBack(const std::string& callback);
    // 指定是否需要高亮展示网页内的违规文本,查询及回调结果时会根据此参数决定是否返回高亮展示的 html 内容。取值为 true 或者 false,默认为 false。
    void SetReturnHighligthHtml(const bool return_highlight_html);
    
    
    // input
    // 网页文件的链接地址,例如 http://www.test.com。
    void SetUrl(const std::string& url);
    // 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。
    void SetDataId(const std::string& data_id);
    // 用户业务字段。
    void SetUserInfo(const UserInfo& user_info);
    CreateWebPageAuditingJobResp 提供的成员函数如下:
    // 获取API请求执行返回的任务详情
    WebPageAuditingJobsDetail GetJobsDetail();
    // 获取API请求的透传ID
    std::string GetRequestId();
    

    返回结果说明

    成功:解析 API 返回的 XML 内容中的审核任务结果到 WebPageAuditingJobsDetail 结构中,具体返回参数可查看 提交网页审核任务 文档。
    失败:发生错误(例如 Bucket 不存在),错误信息则解析在 CosResult 结构体中。详情请参见 异常处理

    查询网页审核任务结果

    功能说明

    用于查询网页审核任务执行情况和结果。

    方法原型

    CosResult DescribeWebPageAuditingJob(const DescribeWebPageAuditingJobReq& req, DescribeWebPageAuditingJobResp* resp);

    请求示例

    qcloud_cos::CosConfig config("./config.json");
    qcloud_cos::CosAPI cos(config);
    std::string bucket_name = "examplebucket-1250000000";
    
    DescribeWebPageAuditingJobReq req(bucket_name);
    DescribeWebPageAuditingJobResp resp;
    
    // 添加请求参数 参数详情请见api接口文档
    req.SetJobId("aab1ca9fc8a3ed11ea834c525400863904");
    
    // 调用接口,获取任务响应对象
    CosResult result = cos.DescribeWebPageAuditingJob(req, &resp);
    if (result.IsSucc()) {
    // 查询审核任务成功,可以调用 DescribeWebPageAuditingJobResp 的成员函数
    } else {
    // 查询审核任务失败,可以调用 CosResult 的成员函数输出错误信息
    }

    参数说明

    参数
    参数描述
    类型
    是否必填
    req
    DescribeWebPageAuditingJob 操作的请求
    DescribeWebPageAuditingJobReq
    resp
    DescribeWebPageAuditingJob 操作的响应
    DescribeWebPageAuditingJobResp
    DescribeWebPageAuditingJobReq 提供以下成员函数:
    // 设置执行操作的bucket
    void SetBucketName(const std::string& bucket_name);
    // 设置查询的审核任务ID
    void SetJobId(const std::string& job_id);
    DescribeWebPageAuditingJobResp 提供的成员函数如下:
    // 获取API请求执行返回的任务详情
    WebPageAuditingJobsDetail GetJobsDetail();
    // 获取API请求的透传ID
    std::string GetRequestId();
    

    返回结果说明

    成功:解析 API 返回的 XML 内容中的审核任务结果到 WebPageAuditingJobsDetail 结构中,具体返回参数可查看 查询网页审核任务结果 文档。
    失败:发生错误(例如 Bucket 不存在),错误信息则解析在 CosResult 结构体中。详情请参见 异常处理
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持