Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to paging query keyword sample info by scenario, keyword, and tag.
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: DescribeWordSamples. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Usages.N | No | Array of String | Keyword application scenario filtering conditions. 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. Abbreviation merge: 5. Recognition: Perform content recognition through OCR and audio recognition technology, equivalent to 1+2; 6. Review: Perform inappropriate content recognition through OCR and audio recognition technology, equivalent to 3+4. Multiple selections allowed. The relationship between elements is "or", meaning records where the keyword's application scenario contains any element in this field collection are compliant with the condition. |
| Keywords.N | No | Array of String | Keyword filtering conditions. Array length limit: 100 words. |
| Tags.N | No | Array of String | Tag filtering condition. Array length limit: 20 words. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 100. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible entries. |
| WordSet | Array of AiSampleWord | Keyword information. |
| 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. |
Traverse the keyword list without any conditions.
https://vod.intl.tencentcloudapi.com/?Action=DescribeWordSamples
&<Common request parameters>{
"Response": {
"TotalCount": 2,
"WordSet": [
{
"Keyword": "Zhang San",
"TagSet": [
"Star"
Artist
],
"UsageSet": [
"Recognition.Ocr",
"Recognition.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
},
{
"Keyword": "Li Si",
"TagSet": [
President
],
"UsageSet": [
"Review.Ocr",
"Review.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
}
],
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}Keyword query by limited conditions such as application scenario.
https://vod.intl.tencentcloudapi.com/?Action=DescribeWordSamples
&Usages.0=Recognition
&Usages.1=Review.Ocr
&Keywords.0=Zhang San
&Tags.0=Star
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"WordSet": [
{
"Keyword": "Zhang San",
"TagSet": [
"Star"
Artist
],
"UsageSet": [
"Recognition.Ocr",
"Recognition.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
}
],
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}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