DescribeContentReviewTemplates
Last updated: 2025-02-19 14:55:53Download PDF
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to query content moderation templates by template ID. Both custom and preset templates that match the template IDs passed in will be returned.
A maximum of 10 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeContentReviewTemplates. |
| 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. |
| Definitions.N | No | Array of Integer | The IDs of the content moderation templates to query. Array length limit: 50. |
| Offset | No | Integer | Paging offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 50. |
| Type | No | String | The filter for querying templates. If this parameter is left empty, both preset and custom templates are returned. Valid values: * Preset * Custom |
| Name | No | String | Filter condition for intelligent auditing template identifiers, with a length limit of 64 characters. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| ContentReviewTemplateSet | Array of ContentReviewTemplateItem | List of content audit template details. |
| 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 Obtaining a Specified Number of Intelligent Auditing Templates
This example shows you how to obtain up to 10 intelligent auditing templates, including default ones, starting from the first record (offset = 0).
Input Example
https://mps.intl.tencentcloudapi.com/?Action=DescribeContentReviewTemplates
&Offset=0
&Limit=10
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 2,
"ContentReviewTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Type": "Preset",
"Comment": "Intelligent content moderation template",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"bloody"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
},
{
"Definition": 31,
"Name": "Template 2",
"Type": "Preset",
"Comment": "Content moderation template",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "OFF"
},
"AsrReviewInfo": {
"Switch": "OFF"
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}
Example2 Obtaining an Intelligent Auditing Template with ID 30
Input Example
https://mps.intl.tencentcloudapi.com/?Action=DescribeContentReviewTemplates
&Definitions.0=30
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"ContentReviewTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Type": "Preset",
"Comment": "Intelligent content moderation template",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"bloody"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}
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. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Definitions | Parameter error: Definitions. |
| InvalidParameterValue.Limit | Parameter error: Limit. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |