控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

简介

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

说明:

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

本文档提供关于文档审核的 API 概览和 SDK 示例代码。

API 操作描述
提交文档审核任务 用于提交一个文档审核任务
查询文档审核任务结果 用于查询指定的文档审核任务

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

提交文档审核任务

功能说明

本接口用于提交一个文档审核任务,可审核您的文档文件是否存在敏感违规信息。文档审核结合了对象存储(Cloud Object Storage,COS)文档预览功能,通过预先将文档转成图片,结合图片内容审核、图片 OCR 审核等方式,进行文档审核。

下面示例展示了如何提交一个文档审核任务,然后何通过 JobId 查询文档审核任务结果。

说明:

  • 此操作需要存储桶开通数据万象相关功能。
  • 文档审核接口从 5.4.24 版本开始支持,下载新版 SDK 前往 Releases 或参见 快速入门
  • 查看版本 Changelog 请前往 GitHub

示例代码

using COSXML.Model.CI;
using COSXML.Auth;
using System;
using System.Threading;
using COSXML;

namespace COSSnippet
{
    public class SubmitDocumentCensorJobModel {

      private CosXml cosXml;

      SubmitDocumentCensorJobModel() {
        CosXmlConfig config = new CosXmlConfig.Builder()
          .SetRegion("COS_REGION") // 设置默认的地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 
          .Build();

        string secretId = "SECRET_ID";   // 云 API 密钥 SecretId, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        string secretKey = "SECRET_KEY"; // 云 API 密钥 SecretKey, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        long durationSecond = 600;          //每次请求签名有效时长,单位为秒
        QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId, 
          secretKey, durationSecond);

        this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
      }

      /// 提交文档审核任务
      public string SubmitDocumentCensorJob()
      {
        // 存储桶名称,此处填入格式必须为 bucketname-APPID, 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
        string bucket = "examplebucket-1250000000"; // 注意:此操作需要 bucket 开通内容审核相关功能
        SubmitDocumentCensorJobRequest request = new SubmitDocumentCensorJobRequest(bucket);
        request.SetUrl("url"); // 审核文档的URL,需要替换成具体需要审核的文档URL
        // 审核的场景类型,有效值:Porn(涉黄)、Ads(广告),可以传入多种类型,不同类型以逗号分隔,例如:Porn,Ads
        request.SetDetectType("Porn,Ads");
        // 执行请求
        SubmitCensorJobResult result = cosXml.SubmitDocumentCensorJob(request);
        Console.WriteLine(result.GetResultInfo());
        Console.WriteLine(result.censorJobsResponse.JobsDetail.JobId);
        Console.WriteLine(result.censorJobsResponse.JobsDetail.State);
        Console.WriteLine(result.censorJobsResponse.JobsDetail.CreationTime);
        return result.censorJobsResponse.JobsDetail.JobId;
      }

      static void Main(string[] args)
      {
        SubmitDocumentCensorJobModel m = new SubmitDocumentCensorJobModel();
        /// 提交审核任务
        string JobId = m.SubmitDocumentCensorJob();
      }
    }
}

说明:

更多完整示例,请前往 GitHub 查看。

查询文档审核任务

功能说明

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

示例代码

using COSXML.Model.CI;
using COSXML.Auth;
using System;
using System.Threading;
using COSXML;

namespace COSSnippet
{
    public class SubmitDocumentCensorJobModel {

      private CosXml cosXml;

      SubmitDocumentCensorJobModel() {
        CosXmlConfig config = new CosXmlConfig.Builder()
          .SetRegion("COS_REGION") // 设置默认的地域, COS 地域的简称请参照 https://cloud.tencent.com/document/product/436/6224 
          .Build();

        string secretId = "SECRET_ID";   // 云 API 密钥 SecretId, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        string secretKey = "SECRET_KEY"; // 云 API 密钥 SecretKey, 获取 API 密钥请参照 https://console.cloud.tencent.com/cam/capi
        long durationSecond = 600;          //每次请求签名有效时长,单位为秒
        QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId, 
          secretKey, durationSecond);

        this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
      }

      /// 查询文档审核任务结果
      public void GetDocumentCensorJobResult(string JobId)
      {
        // 存储桶名称,此处填入格式必须为 bucketname-APPID, 其中 APPID 获取参考 https://console.cloud.tencent.com/developer
        string bucket = "examplebucket-1250000000"; // 注意:此操作需要 bucket 开通内容审核相关功能
        GetDocumentCensorJobRequest request = new GetDocumentCensorJobRequest(bucket, JobId);
        // 执行请求
        GetDocumentCensorJobResult result = cosXml.GetDocumentCensorJob(request);
        Console.WriteLine(result.GetResultInfo());

        // 读取审核结果
        Console.WriteLine(result.resultStruct.JobsDetail.State);
        Console.WriteLine(result.resultStruct.JobsDetail.JobId);
        Console.WriteLine(result.resultStruct.JobsDetail.Suggestion);
        Console.WriteLine(result.resultStruct.JobsDetail.CreationTime);
        Console.WriteLine(result.resultStruct.JobsDetail.Url);
        Console.WriteLine(result.resultStruct.JobsDetail.PageCount);
        Console.WriteLine(result.resultStruct.JobsDetail.Labels);
        Console.WriteLine(result.resultStruct.JobsDetail.Labels.PornInfo.HitFlag);
        Console.WriteLine(result.resultStruct.JobsDetail.Labels.PornInfo.Score);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.Url);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.Text);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.PageNumber);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.PornInfo.HitFlag);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.PornInfo.SubLabel);
        Console.WriteLine(result.resultStruct.JobsDetail.PageSegment.Results.PornInfo.Score);
      }

      static void Main(string[] args)
      {
        SubmitDocumentCensorJobModel m = new SubmitDocumentCensorJobModel();
        /// 输入提交审核任务时返回的, 唯一标识此次审核任务的 JobId
        string JobId = "xxx";
        /// 查询审核任务结果
        m.GetDocumentCensorJobResult(JobId);
      }
    }
}

说明:

更多完整示例,请前往 GitHub 查看。

目录