Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create keyword samples in batches for using OCR and ASR technologies to perform video processing operations such as content recognition and inappropriate information recognition.
A maximum of 100 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: CreateWordSamples. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Usages.N | Yes | Array of String | Keyword application scenario, available values: 1. Recognition.Ocr: Perform content recognition using OCR. 2. Recognition.Asr: Perform content recognition using audio recognition technology. 3. Review.Ocr: Perform inappropriate content recognition using OCR. 4. Review.Asr: Perform inappropriate content recognition through audio recognition technology. Can be abbreviated as: 5. Recognition: Perform content recognition using OCR and audio recognition technology, equivalent to 1+2. 6. Review: Perform inappropriate content recognition using OCR and audio recognition technology, equivalent to 3+4. 7. All: Perform content recognition and inappropriate content recognition through OCR and audio recognition technology, equivalent to 1+2+3+4. |
| Words.N | Yes | Array of AiSampleWordInfo | Keyword, array length limit: 100. |
| SubAppId | No | Integer | On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created). |
| 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. |
UsagesIf All is Review, the keyword can be used for OCR- and ASR-based content recognition and inappropriate information detection.
https://vod.intl.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=Internet celebrity
&Words.0.Tags.0=Entertainment
&<Common request parameters>
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
ReviewIf Recognition is Usages, the keyword can be used for OCR- and ASR-based inappropriate information detection.
https://vod.intl.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=Zhang San
&Words.0.Tags.0=Politics
&<Common request parameters>
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
If
https://vod.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>
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback