Submitting Audio Moderation Job

Last updated: 2023-05-05 17:42:30

Feature Overview

This API is used to submit an audio moderation job. The audio moderation feature is async. You can submit a job to moderate your audio files, and then use the API for Querying Audio Moderation Job Result or Audio Moderation Callback Content to query the moderation results.

The API supports the following operations:

Note：

You can moderate audio files stored in COS.

You can moderate audios at URLs of a third-party cloud storage vendor.

Automatically detect audio files and recognize non-compliant content in ASR and sexy moaning dimensions based on the deep learning technology.
Get the detection results by setting the callback address Callback or calling the API for Querying Audio Moderation Job Result.
Recognize various non-compliant scenes, including pornographic and advertising information.
Customize moderation policies based on different business scenarios as instructed in Setting Moderation Policy.

Billing Details

Each moderation scene is billed separately. For example, if you choose to moderate two scenes involving pornography and advertising, then one audio file will be moderated and billed twice.
Calling the API will incur audio moderation fees and COS read request fees.
If the audio files are stored in COS STANDARD_IA storage class, calling the moderation API will incur STANDARD_IA data retrieval fees as described in Data Retrieval Fees.
Audio moderation is not supported for objects stored in the ARCHIVE or DEEP ARCHIVE storage classes. To moderate these objects, you first need to restore them as instructed in POST Object restore.

Restrictions

Supported audio file size: < 600 MB
Supported audio file duration: < 3 hours
Supported audio bitrate: 128–256 Kbps
Supported audio file format: MP3, WAV, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, or APE.
Supported audio languages: Mandarin, English, Cantonese.
When a video file is used as the input, the audio track can be extracted for audio content moderation.

SDK Recommendation

COS SDK provides complete capabilities of demo, automatic integration, and signature calculation. You can easily and quickly call APIs through the SDK. For more information, see SDK Overview.

Request

Sample request

POST /audio/auditing HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>

Note：

Authorization: Auth String (see Request Signature for more information)

When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.

Request headers

This API only uses Common Request Headers.

Request body

This request requires the following request body:

<Request>
    <Input>
        <Object></Object>
        <Url></Url>
        <DataId></DataId>
    </Input>
    <Conf>
        <Callback></Callback>
        <BizType></BizType>
    </Conf>
</Request>

The nodes are described as follows:

Node Name (Keyword)	Parent Node	Description	Type	Required
Request	None	Audio moderation configuration.	Container	Yes

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
DataId	Request.Input	This field will return the original content in the moderation result, which can contain up to 512 bytes. You can use this field to uniquely identify the data to be moderated in your business.	String	No
UserInfo	Request.Input	Business field.	Container	No

UserInfo has the following sub-nodes:

Node Name (Keyword)	Parent Node	Description	Type	Required
TokenId	Request.Input.UserInfo	Business `TokenId`, which can contain up to 128 bytes.	String	No
Nickname	Request.Input.UserInfo	Business `Nickname`, which can contain up to 128 bytes.	String	No
DeviceId	Request.Input.UserInfo	Business `DeviceId`, which can contain up to 128 bytes.	String	No
AppId	Request.Input.UserInfo	Business `AppId`, which can contain up to 128 bytes.	String	No
Room	Request.Input.UserInfo	Business `Room`, which can contain up to 128 bytes.	String	No
IP	Request.Input.UserInfo	Business `IP`, which can contain up to 128 bytes.	String	No
Type	Request.Input.UserInfo	Business `Type`, which can contain up to 128 bytes.	String	No
ReceiveTokenId	Request.Input.UserInfo	Business `ReceiveTokenId`, which can contain up to 128 bytes.	String	No
Gender	Request.Input.UserInfo	Business `Gender`, which can contain up to 128 bytes.	String	No
Level	Request.Input.UserInfo	Business `Level`, which can contain up to 128 bytes.	String	No
Role	Request.Input.UserInfo	Business `Role`, which can contain up to 128 bytes.	String	No

Conf has the following sub-nodes:

Node Name (Keyword)	Parent Node	Description	Type	Required
BizType	Request.Conf	Unique identifier of the moderation policy. You can configure the scenes you want to moderate on the moderation policy page in the console, such as pornographic and advertising information. For configuration guidelines, see Setting Moderation Policy. You can get `BizType` in the console. If `BizType` is specified, the moderation request will perform moderation based on the scenes configured in the moderation policy. If `BizType` is not specified, the default moderation policy will be used automatically.	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
CallbackType	Request.Conf	Callback segment type. Valid values: `1` (calls back all audio segments); `2` (calls back non-compliant audio segments). Default value: `1`.	Integer	No
Freeze	Request.Conf	This field can be used to set automatic freezing for audio files based on the moderation score. It takes effect only if the audio moderated in `input` is an `object`.	Container	No

Freeze has the following sub-nodes:

Node Name (Keyword)	Parent Node	Description	Type	Required
PornScore	Request.Conf.Freeze	The threshold at or above which automatic freezing will be performed for the porn moderation result. Value range: [0,100]. If this field is left empty (default value), automatic freezing will not be performed.	Integer	No
AdsScore	Request.Conf.Freeze	The threshold at or above which automatic freezing will be performed for the ad moderation result. Value range: [0,100]. If this field is left empty (default value), automatic freezing will not be performed.	Integer	No

For freezing parameters in other moderation scenes, contact the customer service.

Response

Response headers

This API only returns Common Response Headers.

Response body

The response body returns application/xml data. The following contains all the nodes:

<Response>
    <JobsDetail>
        <DataId></DataId>
        <JobId></JobId>
        <State></State>
        <CreationTime></CreationTime>
    </JobsDetail>
    <RequestId></RequestId>
</Response>

The nodes are as described below:

Node Name (Keyword)	Parent Node	Description	Type
Response	None	The specific response content returned by audio moderation.	Container

Response has the following sub-nodes:

Node Name (Keyword)	Parent Node	Description	Type
JobsDetail	Response	Details of the audio moderation job.	Container
RequestId	Response	ID automatically generated by the server for a request when the request is sent, which can be used to facilitate fault locating.	String

JobsDetail has the following sub-nodes:

Node Name (Keyword)	Parent Node	Description	Type
DataId	Response.JobsDetail	Unique business ID added in the request.	String
JobId	Response.JobsDetail	ID of the audio moderation job.	String
State	Response.JobsDetail	Status of the audio moderation job. Valid values: Submitted, Success, Failed, Auditing.	String
CreationTime	Response.JobsDetail	Creation time of the audio moderation job.	String

Error codes

No special error message will be returned for this request. For the common error messages, see Error Codes.

Use Cases

Request

POST /audio/auditing HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Input>
        <Object>a.mp3</Object>
        <DataId>123-fdrsg-123</DataID>
    </Input>
    <Conf>
        <BizType>b81d45f94xxxxxxxxa9506f45a11</BizType>
        <Callback>http://callback.com/</Callback>
    </Conf>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <DataId>123-fdrsg-123</DataID>
        <JobId>vab1ca9fc8a3ed11ea834c525400863904</JobId>
        <State>Submitted</State>
        <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
    </JobsDetail>
    <RequestId>xxxxxxxxxxxxxx</RequestId>
</Response>

tencent cloud

Recent Pages