CreateContentReviewTemplate
1. API Description
Domain name for API request: mps.tencentcloudapi.com.
This API is used to create a custom content moderation template. Up to 50 templates can be created in total.
A maximum of 10 requests can be initiated per second for this API.
2. Input Parameters
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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Name | No | String | The name of the content moderation template. Length limit: 64 characters. |
Comment | No | String | The template description. 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: Note: this parameter is not supported yet. |
UserDefineConfigure | No | UserDefineConfigureInfo | Custom content moderation parameters. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
Definition | Integer | The unique ID of the content moderation 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. |
4. Example
Example1 Creating a Content Moderation Template to Perform Multiple Moderation Tasks
This example shows you how to create a custom AI content moderation template to detect pornographic, terrorist, and politically sensitive content in images using the default thresholds for rule violation and manual recognition, without specifying a filter tag.
Input Example
https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
&Name=Content Moderation Template
&Comment=Template 3
&PornConfigure.ImgReviewInfo.Switch=ON
&TerrorismConfigure.ImgReviewInfo.Switch=ON
&TerrorismConfigure.OcrReviewInfo.Switch=OFF
&PoliticalConfigure.ImgReviewInfo.Switch=ON
&<Common request parameters>
Output Example
{
"Response": {
"Definition": 31,
"RequestId": "97aee3e9-2qd3-4151-9d4b-9730a45227a9"
}
}
Example2 Creating a Content Moderation Template to Detect Pornographic Content
This example shows you how to create a custom AI content moderation template to detect pornographic content in images using the default thresholds for rule violation and manual recognition, without specifying a filter tag.
Input Example
https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
&Name=Content Moderation Template
&Comment=Template 1
&PornConfigure.ImgReviewInfo.Switch=ON
&<Common request parameters>
Output Example
{
"Response": {
"Definition": 30,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Example3 Creating a Content Moderation Template to Detect Pornographic Content with Specified Tags
This example shows you how to create a custom AI content moderation template to detect pornographic content in images using the default thresholds for rule violation and manual recognition, with the tags specified as porn
and sexy
.
Input Example
https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
&Name=Content Moderation Module
&Comment=Template 1
&PornConfigure.ImgReviewInfo.Switch=ON
&PornConfigure.ImgReviewInfo.LabelSet.0=porn
&PornConfigure.ImgReviewInfo.LabelSet.1=sexy
&<Common request parameters>
Output Example
{
"Response": {
"Definition": 32,
"RequestId": "88aee3e9-2qd3-4151-9d4b-4390a45227a9"
}
}
Example4 Creating a Content Moderation Template to Detect Pornographic Content, and Specifying the Threshold and Frame Interception Interval
This example shows you how to create a custom AI content moderation template to detect pornographic content in images, with the thresholds for rule violation and manual recognition set to 80 and 30, respectively.
Input Example
https://mps.tencentcloudapi.com/?Action=CreateContentReviewTemplate
&Name=Content Moderation Template
&Comment=Template 2
&PornConfigure.ImgReviewInfo.Switch=ON
&PornConfigure.ImgReviewInfo.BlockConfidence=80
&PornConfigure.ImgReviewInfo.ReviewConfidence=30
&<Common request parameters>
Output Example
{
"Response": {
"Definition": 33,
"RequestId": "67aee3e9-2qd3-2395-9d4b-4390a96837a7"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.InvalidMpsUser | Operation failed: unauthorized MPS user. |
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 | Parameter error: template description. |
InvalidParameterValue.LabelSet | Incorrect parameter value: invalid LabelSet value. |
InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
InvalidParameterValue.ReviewConfidence | Incorrect parameter value: The value of the ReviewConfidence parameter is invalid. |
InvalidParameterValue.Switch | Incorrect parameter value: invalid Switch value. |
LimitExceeded.TooMuchTemplate | Limit reached: the number of templates exceeds the limit. |