Content Moderation:Video File Moderation 2.0 API

Usage instructions

1. Create an Alibaba Cloud account: Click Register account and follow the instructions to create an Alibaba Cloud account.

2. Activate the pay-as-you-go billing method for Content Moderation: Make sure that the Content Moderation 2.0 service is activated. You are not charged for activating this service. After you call API operations, the billing system automatically charges you based on your usage. For more information, see Billing methods.

3. Create an AccessKey pair: Make sure that you have created an AccessKey pair as a Resource Access Management (RAM) user. For more information, see Create an AccessKey pair. If you want to use the AccessKey pair of the RAM user, use your Alibaba Cloud account to grant the AliyunYundunGreenWebFullAccess permission to the RAM user. For more information, see Grant permissions to a RAM user.

4. Use SDKs: We recommend that you use SDKs to call API operations. For more information, see Guide of using Video Moderation 2.0.

Submit a moderation task

Usage notes

• Operation: VideoModeration (only for asynchronous moderation)

• Supported regions and endpoints

  Region	Public endpoint	Internal endpoint	Supported service
  Singapore	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com	videoDetection_global

• Billing methods

  You are charged for calling this operation. The billing system charges you based on the image moderation policy and voice moderation policy that you set for video files. If multiple moderation services are called to moderate the images in video files, fees are accumulated based on the number of captured frames multiplied by the unit price of each moderation service. If video files are moderated for voice content violations at the same time, you are also charged for the video duration multiplied by the unit price of voice moderation. For more information about the billing method, see Billing methods.

• Moderation objects: Video files

• Returned results: If you send asynchronous moderation requests, the moderation results are not returned in real time. To obtain moderation results, you can poll the moderation results periodically or enable callback notification. The moderation results are retained for up to 24 hours.

  • Enable callback notification to obtain moderation results: When you submit an asynchronous moderation task, you can specify a callback URL for receiving moderation results in the callback parameter of the moderation request.

  • Poll moderation results: You do not need to set the callback parameter when you submit asynchronous moderation tasks. After you submit the tasks, you can call the result query operation to query moderation results.

• Limits on video files

  • The URLs of video files must be HTTP or HTTPS URLs.

  • The video files must be in AVI, FLV, MP4, MPG, ASF, WMV, MOV, WMA, RMVB, RM, FLASH, or TS format.

  • A video file can be up to 500 MB in size. If the video file to be moderated exceeds 500 MB, you can segment the video file. Alternatively, you can contact the technical support personnel to help you adjust the size limit.

  • The time for video moderation varies with the duration for downloading the video file. Make sure that you use a stable and reliable storage service to store the video files to be moderated. We recommend that you use Object Storage Service (OSS) provided by Alibaba Cloud.

• Moderation rule configurations

  • Before you call the Video Moderation API for the first time, you must configure video moderation rules in the Content Moderation console.

  • If you do not configure video moderation rules, the Video Moderation 2.0 API uses the following default configurations:

    Video moderation (videoDetection_global)

    • Frequency of capturing frames: 1 second/frame

    • Image moderation service: common baseline moderation (baselineCheck_global)

    • Voice moderation: enabled

    • Voice moderation service: multi-language voice moderation (audio_multilingual_global)

    • Returned results: Only the risky content is returned.

QPS limits

You can call this operation up to 100 times per second per account. Only 50 moderation tasks can be processed at a time. If you need to increase the number of concurrent moderation tasks, consult your business manager. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

Before you deploy SDKs, you can use Alibaba Cloud OpenAPI Explorer to debug the VideoModeration operation online and view the sample code for the call and SDK dependencies. This way, you can understand how to call the operation and how to set related parameters.

Request parameters

Table 1 ServiceParameters

Response parameters

Examples

Sample requests

{
    "Service": "videoDetection_global",
    "ServiceParameters": {
        "url": "http://www.aliyundoc.com/a.flv",
        "dataId": "videoId****"
    }
}

Sample success responses

{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}

Obtain the moderation results of a video file moderation task

Usage notes

• Operation: VideoModerationResult, which is used to obtain the moderation results of a video file moderation task.

• Billing: This operation is free of charge.

• Response timeout: We recommend that you query moderation results at least 30s after you send an asynchronous moderation request. Content Moderation retains moderation results for up to 24 hours. After 24 hours, the results are deleted.

QPS limits

You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

Before you deploy SDKs, you can use Alibaba Cloud OpenAPI Explorer to debug the VideoModerationResult operation online and view the sample code for the call and SDK dependencies. This way, you can understand how to call the operation and how to set related parameters.

Request parameters

Table 1 ServiceParameters

Response parameters

Table 2 Data

Table 3 FrameResult

Table 4 FrameSummary

Table 5 Frame

Table 6 Results

Table 7 Result

Table 8 audioResult

Table 9 AudioSummarys

Table 10 SliceDetails

Examples

Sample requests

{
    "Service": "videoDetection_global",
    "ServiceParameters": {
        "taskId": "abcd****"
    }
}

Sample success responses

• Moderate only images in a video file

{
    "Code": 200,
    "RequestId": "25106421-XXXX-XXXX-XXXX-15DA5AAAC546",
    "Message": "success finished",
    "Data": {
        "DataId": "dc16c28f-xxxx-xxxx-xxxx-51efe0131080",
        "FrameResult": {
            "FrameNum": 2,
            "FrameSummarys": [
                {
                    "Label": "violent_explosion",
                    "LabelSum": 8
                },
                {
                    "Label": "sexual_cleavage",
                    "LabelSum": 5
                }
            ],
            "Frames": [
                {
                    "Offset": 1,
                    "Results": [
                        {
                            "Result": [
                                {
                                    "Label": "nonLabel"
                                }
                            ],
                            "Service": "baselineCheck_global"
                        }
                    ],
                    "TempUrl": "http://abc.oss-ap-southeast-1.aliyuncs.com/test1.jpg"
                },
                {
                    "Offset": 2,
                    "Results": [
                        {
                            "Result": [
                                {
                                    "Confidence": 1,
                                    "Label": "sexual_cleavage"
                                },
                                {
                                    "Confidence": 74.1,
                                    "Label": "violent_explosion"
                                }
                            ],
                            "Service": "baselineCheck_global"
                        }
                    ],
                    "TempUrl": "http://abc.oss-ap-southeast-1.aliyuncs.com/test2.jpg"
                }
            ]
        }
    }
}

• Moderate both images and voices in a video file

{
    "Code": 200,
    "RequestId": "25106421-XXXX-XXXX-XXXX-15DA5AAAC546",
    "Message": "success finished",
    "Data": {
        "AudioResult": {
            "AudioSummarys": [
                {
                    "Label": "sexual_sounds",
                    "LabelSum": 3
                }
            ],
            "SliceDetails": [
                {
                    "EndTime": 60,
                    "EndTimestamp": 1698912813192,
                    "Labels": "",
                    "StartTime": 30,
                    "StartTimestamp": 1698912783192,
                    "Text": "Content Moderation",
                    "Url": "http://abc.oss-ap-southeast-1.aliyuncs.com/test.wav"
                },
                {
                    "EndTime": 30,
                    "EndTimestamp": 1698912813192,
                    "Extend": "{\"customizedWords\":\"Service\",\"customizedLibs\":\"test\"}",
                    "Labels": "C_customized",
                    "StartTime": 0,
                    "StartTimestamp": 1698912783192,
                    "Text": "Welcome to the Alibaba Cloud Content Moderation service",
                    "Url": "http://abc.oss-ap-southeast-1.aliyuncs.com/test.wav"
                }
            ]
        },
        "DataId": "dc16c28f-xxxx-xxxx-xxxx-51efe0131080",
        "FrameResult": {
            "FrameNum": 2,
            "FrameSummarys": [
                {
                    "Label": "violent_explosion",
                    "LabelSum": 8
                },
                {
                    "Label": "sexual_cleavage",
                    "LabelSum": 8
                }
            ],
            "Frames": [
                {
                    "Offset": 1,
                    "Results": [
                        {
                            "Result": [
                                {
                                    "Label": "nonLabel"
                                }
                            ],
                            "Service": "baselineCheck_global"
                        }
                    ],
                    "TempUrl": "http://abc.oss-ap-southeast-1.aliyuncs.com/test1.jpg"
                },
                {
                    "Offset": 2,
                    "Results": [
                        {
                            "Result": [
                                {
                                    "Confidence": 1,
                                    "Label": "sexual_cleavage"
                                },
                                {
                                    "Confidence": 74.1,
                                    "Label": "violent_explosion"
                                }
                            ],
                            "Service": "baselineCheck_global"
                        }
                    ],
                    "TempUrl": "http://abc.oss-ap-southeast-1.aliyuncs.com/test2.jpg"
                }
            ]
        }
    }
}

Response codes

The following table describes the response codes for calling Video File Moderation 2.0 API operations. You are charged by using the pay-as-you-go billing method only for requests whose response codes are 200 and 280.