com.tencentcloudapi.ams.v20201229

Class AmsClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ams.v20201229.AmsClient

public class AmsClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
AmsClient(Credential credential, String region)
AmsClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CancelTaskResponse	CancelTask(CancelTaskRequest req) This API is used to cancel a moderation task.
CreateAudioModerationTaskResponse	CreateAudioModerationTask(CreateAudioModerationTaskRequest req) This API is used to submit audio content (such as an audio file or stream URL) for smart moderation.
DescribeTaskDetailResponse	DescribeTaskDetail(DescribeTaskDetailRequest req) This API is used to view the details of an audio moderation task, including task status, detection result, recognized text content of the audio file, maliciousness tag that corresponds to the detection result, and suggested operation.
DescribeTasksResponse	DescribeTasks(DescribeTasksRequest req) This API is used to view the list of moderation tasks.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AmsClient

public AmsClient(Credential credential,
                 String region)

AmsClient

public AmsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

CancelTask

public CancelTaskResponse CancelTask(CancelTaskRequest req)
                              throws TencentCloudSDKException

This API is used to cancel a moderation task. If it returns `RequestId`, the task has been canceled successfully.
Default API request rate limit: **20 requests/sec**.

Parameters:

req - CancelTaskRequest

Returns:

CancelTaskResponse

Throws:

TencentCloudSDKException

CreateAudioModerationTask

public CreateAudioModerationTaskResponse CreateAudioModerationTask(CreateAudioModerationTaskRequest req)
                                                            throws TencentCloudSDKException

This API is used to submit audio content (such as an audio file or stream URL) for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account [to activate AMS](https://console.cloud.tencent.com/cms/audio/package) and adjust the business configuration.
### Feature use instructions - Go to the "[CMS console - AMS](https://console.cloud.tencent.com/cms/audio/package)" to activate AMS. - Default API request rate limit: **20 requests/sec**. When this limit is exceeded, requests for async moderation tasks (audio on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (audio live streaming). ### API feature description - It can detect audio streams or files for non-compliant content; - You can set the callback address (Callback) to get the detection result (for moderation tasks in progress, the maximum callback time is the configured **segment length + 2s). You can also call the API for querying the audio detection result to poll the detection result; - It can recognize various types of non-compliant content, including vulgarity, abuse, porn, and advertising; - You can submit **up to 10** detection tasks at a time. ### Call description for audio file - Supported audio file size: **< 500 MB**; - Supported audio file duration: **< 1 hour**; - Supported audio bitrate: 128–256 Kbps; - Supported audio file formats: WAV, MP3, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, and APE; - **When the input is a video file**, the audio track can be extracted from it for audio content moderation. ### Call description for audio stream - Supported audio stream duration: **< 3 hours**; - Supported audio bitrate: 128–256 Kbps; - Supported audio stream transfer protocols: RTMP, HTTP, and HTTPS; - Supported audio stream formats: RTP, SRTP, RTMP, RTMPS, MMSH, MMST, HLS, HTTP, TCP, HTTPS, and M3U8; - **When the input is a video stream**, the audio track can be extracted from it for audio content moderation.

Parameters:

req - CreateAudioModerationTaskRequest

Returns:

CreateAudioModerationTaskResponse

Throws:

TencentCloudSDKException

DescribeTaskDetail

public DescribeTaskDetailResponse DescribeTaskDetail(DescribeTaskDetailRequest req)
                                              throws TencentCloudSDKException

This API is used to view the details of an audio moderation task, including task status, detection result, recognized text content of the audio file, maliciousness tag that corresponds to the detection result, and suggested operation. For the specific output content, see the sample output parameters.
Default API request rate limit: **100 requests/sec**.

Parameters:

req - DescribeTaskDetailRequest

Returns:

DescribeTaskDetailResponse

Throws:

TencentCloudSDKException

DescribeTasks

public DescribeTasksResponse DescribeTasks(DescribeTasksRequest req)
                                    throws TencentCloudSDKException

This API is used to view the list of moderation tasks. You can also filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status. The output content of the task list includes the total number of queried tasks, task name, task status, audio moderation type, maliciousness tag of the detection result, and suggested operation. For the specific output content, see the sample output parameters.
Default API request rate limit: **20 requests/sec**.

Parameters:

req - DescribeTasksRequest

Returns:

DescribeTasksResponse

Throws:

TencentCloudSDKException