tencent cloud

Feedback

Text Moderation

Last updated: 2024-02-06 16:47:20

    Overview

    This document describes how to use the content moderation feature provided by Cloud Infinite (CI). CI fully integrates the processing capabilities with the COS SDK.
    Note:
    To use the content moderation service, you need to have the permission to use CI:
    For root accounts, click here for role authorization.
    This document provides an overview of APIs and SDK code samples for text moderation.
    API
    Description
    Submits text moderation job.
    Queries the result of specified text moderation job.

    Submitting Text Moderation Job

    Feature description

    This API is used to submit a text moderation job. You can submit a job to moderate your text files, and then use the API for querying text moderation job result to query the moderation results.
    The following example shows how to submit a text moderation job and then query the result by JobId.
    Note:
    To perform this operation, the bucket should have CI features enabled.
    Text moderation APIs are supported starting from v5.4.24. To download the latest SDK, go to Releases or see Getting Started.
    To view the version change log, go to GitHub.

    Sample code

    using COSXML.Model.CI;
    using COSXML.Auth;
    using System;
    using System.Threading;
    using COSXML;
    
    namespace COSSnippet
    {
    public class SubmitTextCensorJobModel {
    
    private CosXml cosXml;
    
    SubmitTextCensorJobModel() {
    CosXmlConfig config = new CosXmlConfig.Builder()
    .SetRegion("COS_REGION") // Set the default region. For the abbreviations for COS regions, visit https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1.
    .Build();
    
    string secretId = "SECRET_ID"; // `SecretId` of your TencentCloud API key. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
    string secretKey = "SECRET_KEY"; // `SecretKey` of your TencentCloud API key. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
    long durationSecond = 600; // Validity period of the request signature in seconds
    QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId,
    secretKey, durationSecond);
    
    this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
    }
    
    /// Submit the text moderation job
    public string SubmitTextCensorJob()
    {
    // Bucket name, which must be in the format of `bucketname-APPID`. For more information on how to get the `APPID`, visit https://console.tencentcloud.com/developer.
    string bucket = "examplebucket-1250000000"; // Note: To perform this operation, the bucket should have the content moderation feature enabled.
    SubmitTextCensorJobRequest request = new SubmitTextCensorJobRequest(bucket);
    request.SetCensorObject("text.txt"); // Object key of the media file, which should be replaced with that of the actual media file in the bucket.
    // The scene to be moderated, such as `Porn` (pornography) and `Ads` (advertising). You can pass in multiple types and separate them by comma, such as `Porn,Ads`.
    request.SetDetectType("Porn,Ads");
    // Execute the request
    SubmitCensorJobResult result = cosXml.SubmitTextCensorJob(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;
    //.cssg-snippet-body-end
    }
    
    static void Main(string[] args)
    {
    SubmitTextCensorJobModel m = new SubmitTextCensorJobModel();
    /// Submit the moderation job
    string JobId = m.SubmitTextCensorJob();
    /// Print the `JobId` that uniquely identifies this moderation job
    Console.WriteLine("JobId : " + JobId);
    }
    }
    }
    
    Note:
    For more complete samples, visit GitHub.

    Querying Text Moderation Job

    Feature description

    This API is used to query the status and result of a text moderation job.

    Sample code

    using COSXML.Model.CI;
    using COSXML.Auth;
    using System;
    using System.Threading;
    using COSXML;
    
    namespace COSSnippet
    {
    public class SubmitTextCensorJobModel {
    
    private CosXml cosXml;
    
    SubmitTextCensorJobModel() {
    CosXmlConfig config = new CosXmlConfig.Builder()
    .SetRegion("COS_REGION") // Set the default region. For the abbreviations for COS regions, visit https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1.
    .Build();
    
    string secretId = "SECRET_ID"; // `SecretId` of your TencentCloud API key. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
    string secretKey = "SECRET_KEY"; // `SecretKey` of your TencentCloud API key. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
    long durationSecond = 600; // Validity period of the request signature in seconds
    QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId,
    secretKey, durationSecond);
    
    this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
    }
    
    /// Query the text moderation job result
    public void GetTextCensorJobResult(string JobId)
    {
    // Bucket name, which must be in the format of `bucketname-APPID`. For more information on how to get the `APPID`, visit https://console.tencentcloud.com/developer.
    string bucket = "examplebucket-1250000000"; // Note: To perform this operation, the bucket should have the content moderation feature enabled.
    GetTextCensorJobRequest request = new GetTextCensorJobRequest(bucket, JobId);
    // Execute the request
    GetTextCensorJobResult result = cosXml.GetTextCensorJob(request);
    Console.WriteLine(result.GetResultInfo());
    
    // Read the moderation result
    Console.WriteLine(result.resultStruct.JobsDetail.JobId);
    Console.WriteLine(result.resultStruct.JobsDetail.State);
    Console.WriteLine(result.resultStruct.JobsDetail.CreationTime);
    Console.WriteLine(result.resultStruct.JobsDetail.Object);
    Console.WriteLine(result.resultStruct.JobsDetail.SectionCount);
    Console.WriteLine(result.resultStruct.JobsDetail.Result);
    
    Console.WriteLine(result.resultStruct.JobsDetail.PornInfo.HitFlag);
    Console.WriteLine(result.resultStruct.JobsDetail.PornInfo.Count);
    Console.WriteLine(result.resultStruct.JobsDetail.AdsInfo.HitFlag);
    Console.WriteLine(result.resultStruct.JobsDetail.AdsInfo.Count);
    
    // Information of text sections
    for(int i = 0; i < result.resultStruct.JobsDetail.Section.Count; i++)
    {
    Console.WriteLine(result.resultStruct.JobsDetail.Section[i].StartByte);
    Console.WriteLine(result.resultStruct.JobsDetail.Section[i].PornInfo.HitFlag);
    Console.WriteLine(result.resultStruct.JobsDetail.Section[i].PornInfo.Score);
    Console.WriteLine(result.resultStruct.JobsDetail.Section[i].PornInfo.Keywords);
    }
    }
    
    static void Main(string[] args)
    {
    SubmitTextCensorJobModel m = new SubmitTextCensorJobModel();
    // Enter the `JobId` obtained when you submit the text moderation job
    string JobId = "xxx";
    // Query the moderation job result
    m.GetTextCensorJobResult(JobId);
    }
    }
    }
    
    Note:
    For more complete samples, visit GitHub.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support