Domain name for API request: vod.tencentcloudapi.com.
This API is used to create keyword samples in batches for video processing operations such as content recognition and audit by using the OCR and ASR technologies.
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 use case. Valid values: 1. Recognition.Ocr: OCR-based content recognition; 2. Recognition.Asr: ASR-based content recognition; 3. Review.Ocr: OCR-based content audit; 4. Review.Asr: ASR-based content audit; These values can be merged as follows: 5. Recognition: ASR-based and OCR-based content recognition, which is equivalent to 1+2 above; 6. Review: ASR-based and OCR-based content audit, which is equivalent to 3+4 above; 7. All: ASR-based and OCR-based content recognition and audit, which is equivalent to 1+2+3+4 above; |
| 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. |
If Usages is All, then this keyword can be used for OCR-based and ASR-based content recognition and audit.
https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=Influencer
&Words.0.Tags.0=Entertainment
&<common request parameters>{
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}If Usages is ["Recognition.Ocr","Review.Ocr"], then this keyword can be used for OCR-based content recognition and audit.
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>{
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}If Usages is Review, then this keyword can be used for OCR-based and ASR-based content audit.
https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=John Smith
&Words.0.Tags.0=Politically sensitive
&<common request parameters>{
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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?