Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create keyword samples in batches. The samples are used for video processing such as inappropriate content recognition and content recognition through 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 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 through OCR. 2. Recognition.Asr: Perform content recognition through audio recognition technology. 3. Review.Ocr: Perform inappropriate content recognition through OCR. 4. Review.Asr: Perform inappropriate content recognition through audio recognition technology; Can be abbreviated as: 5. Recognition: Perform content recognition through 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 | VOD application ID. For customers who activate VOD after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID. |
| 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. |
AllIf Usages is All, 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 Usages is Review, 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"
}
}RecognitionIf Usages is ["Recognition.Ocr","Review.Ocr"], the keyword can be used for OCR-based content recognition and inappropriate information detection.
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. |
文档反馈