Domain name for API request: vod.tencentcloudapi.com.
We have stopped updating this API. Our new moderation templates can moderate audio/video as well as images. For details, see CreateReviewTemplate.
This API is used to create a custom audio/video moderation template. Up to 50 templates can be created in total.
A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: CreateContentReviewTemplate. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
Region | No | String | Common Params. This parameter is not required. |
ReviewWallSwitch | Yes | String | Whether to allow the recognition result to enter the intelligent recognition platform (for human recognition). |
SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Name | No | String | Name of an intelligent content recognition template. Length limit: 64 characters. |
Comment | No | String | Description of an intelligent content recognition template. Length limit: 256 characters. |
PornConfigure | No | PornConfigureInfo | Control parameter for porn information. |
TerrorismConfigure | No | TerrorismConfigureInfo | Control parameter for terrorism information. |
PoliticalConfigure | No | PoliticalConfigureInfo | Control parameter for politically sensitive information. |
ProhibitedConfigure | No | ProhibitedConfigureInfo | Control parameter of prohibited information detection. Prohibited information includes: |
UserDefineConfigure | No | UserDefineConfigureInfo | Control parameter for custom intelligent content recognition. |
ScreenshotInterval | No | Float | Frame capturing interval in seconds. If this parameter is left empty, 1 second will be used by default. Minimum value: 0.5 seconds. |
Parameter Name | Type | Description |
---|---|---|
Definition | Integer | Unique ID of an intelligent recognition template. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create a custom AI content review template, enable the task of information with objectionable content on the screen, and at the same time enable the task of information with unsafe content and inappropriate information, determine the score threshold for violations, and determine the need for manual identification The score thresholds of are all default and no filtering label is specified.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContentReviewTemplate
<Public Request Parameter>
{
"Comment": "test template",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON"
}
},
"ReviewWallSwitch": "OFF",
"Name": "TestTemplate",
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON"
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON"
},
"OcrReviewInfo": null
}
}
{
"Response": {
"Definition": 32,
"RequestId": "88aee3e9-2qd3-4151-9d4b-4390a45227a9"
}
}
Create a custom AI content review template, and only enable the task of information with objectionable screen content. The score thresholds that are judged as violations and the score thresholds that are judged as requiring manual identification are both default values, and no filtering labels are specified.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContentReviewTemplate
<Public Request Parameter>
{
"Comment": "Template 1",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON"
}
},
"ReviewWallSwitch": "OFF",
"Name": "Content moderation template"
}
{
"Response": {
"Definition": 30,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Create a custom AI content review template, start the information task of objectionable screen content, specify the score threshold for judging the screen violation to be 80 points, the threshold score for judging the screen to require manual identification as 30 points, and the frame interception interval as 1 second .
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContentReviewTemplate
<Public Request Parameter>
{
"Comment": "Template 2",
"PornConfigure": {
"ImgReviewInfo": {
"BlockConfidence": "80",
"Switch": "ON",
"ReviewConfidence": "30"
}
},
"ReviewWallSwitch": "OFF",
"Name": "Content moderation template",
"ScreenshotInterval": "1"
}
{
"Response": {
"Definition": 31,
"RequestId": "97aee3e9-2qd3-4151-9d4b-9730a45227a9"
}
}
Create a custom AI content review template, start the screen content pornographic identification task, specify the filter tags as pornographic and sexy, and set the score thresholds for violations and manual review as the default.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateContentReviewTemplate
<Public Request Parameter>
{
"Comment": "Template 1",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"sexy",
"porn"
]
}
},
"ReviewWallSwitch": "OFF",
"Name": "Content moderation template"
}
{
"Response": {
"Definition": 33,
"RequestId": "67aee3e9-2qd3-2395-9d4b-4390a96837a7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.InvalidVodUser | The VOD service is not activated. |
InternalError | Internal error. |
InternalError.GenDefinition | Internal error: failed to generate template ID. |
InvalidParameterValue.BlockConfidence | Incorrect parameter value: the value of the BlockConfidence parameter is invalid. |
InvalidParameterValue.Comment | Invalid parameter: template description. |
InvalidParameterValue.LabelSet | Incorrect parameter value: the value of the LabelSet parameter is invalid. |
InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
InvalidParameterValue.ReviewConfidence | Incorrect parameter value: the value of the ReviewConfidence parameter is invalid. |
InvalidParameterValue.ReviewWallSwitch | Incorrect parameter value: the value of the ReviewWallSwitch parameter is invalid. |
InvalidParameterValue.ScreenshotInterval | Incorrect parameter value: the value of the ScreenshotInterval parameter is invalid. |
InvalidParameterValue.Switch | Incorrect parameter value: the value of the Switch parameter is invalid. |
LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket。 |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?