Domain name for API request: vod.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 parameter. The value used for this API: CreateWordSamples. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. 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 recognition; equivalent to 1+2+3+4 |
| Words.N | Yes | Array of AiSampleWordInfo | Keyword. Array length limit: 100. |
| SubAppId | No | Integer | Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
ReviewIf Usages=Review, then this keyword can be used for OCR- and ASR-based inappropriate information recognition.
https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=John Smith
&Words.0.Tags.0=Politically sensitive
&<Common request parameters>{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}RecognitionIf Usages=["Recognition.Ocr","Review.Ocr"], then this keyword can be used for OCR-based content recognition and inappropriate information recognition.
https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Recognition.Ocr
&Usages.1=Review.Ocr
&Words.0.Keyword=Influencer
&Words.0.Tags.0=Entertainment
&<Common request parameters>{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}AllIf Usages=All, then this keyword can be used for OCR- and ASR-based content recognition and inappropriate information recognition.
https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=Influencer
&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 | Incorrect parameter value. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?