CreateWordSamples
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to create keyword samples in batches for video processing operations such as content recognition and inappropriate information detection with the help of the OCR and ASR technologies.
A maximum of 100 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: CreateWordSamples. |
| 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. |
| Usages.N | Yes | Array of String | Keyword usage. Valid values: 1. Recognition.Ocr: OCR-based content recognition 2. Recognition.Asr: ASR-based content recognition 3. Review.Ocr: OCR-based inappropriate information recognition 4. Review.Asr: ASR-based inappropriate information recognition Valid values can also be: 5. Recognition: ASR- and OCR-based content recognition; equivalent to 1+2 6. Review: ASR- and OCR-based inappropriate information recognition; equivalent to 3+4 7. All: ASR- and OCR-based content recognition and inappropriate information detection; equivalent to 1+2+3+4 |
| Words.N | Yes | Array of AiSampleWordInfo | Keyword. Array length limit: 100. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| 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 Keyword Sample - All
If Usages is All, the keyword can be used for OCR- and ASR-based content recognition and inappropriate information detection.
Input Example
https://mps.intl.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=Internet celebrity
&Words.0.Tags.0=Entertainment
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Example2 Creating a Keyword Sample - Review
If Usages is Review, the keyword can be used for OCR- and ASR-based inappropriate information detection.
Input Example
https://mps.intl.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=Zhang San
&Words.0.Tags.0=Politics
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Example3 Creating a Keyword Sample - Recognition
If Usages is ["Recognition.Ocr","Review.Ocr"], the keyword can be used for OCR-based content recognition and inappropriate information detection.
Input Example
https://mps.intl.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Recognition.Ocr
&Usages.1=Review.Ocr
&Words.0.Keyword=Internet celebrity
&Words.0.Tags.0=Entertainment
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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. |
| InvalidParameterValue | Incorrect parameter value. |