tencent cloud

Feedback

Audio Moderation

Last updated: 2022-08-10 15:03:31

    Overview

    This document provides an overview of APIs and SDK code samples for audio moderation.

    Note:

    The COS Node.js SDK version must be at least v2.11.2.

    API Description
    Submitting audio moderation job Submits audio moderation job.
    Querying audio moderation job result Queries the result of specified audio moderation job.

    Submitting Audio Moderation Job

    Feature description

    This API is used to submit an audio moderation job.

    Sample request

    var config = {
    // Replace with your own bucket information
    Bucket: 'examplebucket-1250000000', /* Bucket (required) */
    Region: 'COS_REGION', /* Bucket region (required) */
    };
    function postAudioAuditing() {
    var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
    var url = 'https://' + host + '/audio/auditing';
    var body = COS.util.json2xml({
      Request: {
        Input: {
          Object: '1.mp3', /* Path of the audio file to be moderated in the bucket */
        },
        Conf: {
          BizType: '',
          DetectType: 'Porn',
        }
      }
    });
    cos.request({
        Bucket: config.Bucket,
        Region: config.Region,
        Method: 'POST',
        Url: url,
        Key: '/audio/auditing', /** Fixed value (required) */
        ContentType: 'application/xml', /** Fixed value (required) */
        Body: body
    },
    function(err, data){
        console.log(err || data);
    });
    }
    

    Parameter description

    Request has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Input Request Content to be moderated. Container Yes
    Conf Request Moderation rule configuration. Container Yes

    Input has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    Object Request.Input Name of the audio file stored in the COS bucket; for example, if the file is audio.mp3 in the test directory, then the filename is test/audio.mp3. Either Object or Url can be selected at a time. String No
    Url Request.Input Full URL of the audio file, such as http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/audio.mp3. Either Object or Url can be selected at a time. String No

    Conf has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type Required
    DetectType Request.Conf The scene to be moderated, such as Porn (pornography), Ads (advertising), Illegal (illegal), and Abuse (abusive). You can pass in multiple types and separate them by comma, such as Porn,Ads. String No
    Callback Request.Conf The moderation result can be sent to your callback address in the form of a callback. Addresses starting with http:// or https:// are supported, such as http://www.callback.com. String No
    CallbackVersion Request.Conf Structure of the callback content. Valid values: Simple (the callback content contains basic information), Detail (the callback content contains detailed information). Default value: Simple. string No
    BizType Request.Conf Moderation policy. If this parameter is not specified, the default policy will be used. The policy can be configured in the console. String No

    Response description

    For more information, see Submitting Audio Moderation Job.

    Querying Audio Moderation Job

    Feature description

    This API is used to query the status and result of an audio moderation job.

    Sample request

    var config = {
    // Replace with your own bucket information
    Bucket: 'examplebucket-1250000000', /* Bucket (required) */
    Region: 'COS_REGION', /* Bucket region (required) */
    };
    function getAudioAuditingResult() {
    var jobId = 'sa0c28d41daff411ecb23352540078cxxx'; // `jobId`, which is returned after an audio moderation job is submitted.
    var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com';
    var url = 'https://' + host + '/audio/auditing/' + jobId;
    cos.request({
        Bucket: config.Bucket,
        Region: config.Region,
        Method: 'GET',
        Key: '/audio/auditing/' + jobId,
        Url: url,
    },
    function(err, data){
        console.log(err || data);
    });
    }
    

    Parameter description

    Parameter Description Type Required
    jobId ID of the job to be queried. String Yes

    Response description

    For more information, see Querying Audio Moderation Job Result.

    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