Domain name for API request: vod.tencentcloudapi.com.
This API is used to perform paginated queries of keyword sample information by use case, 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 parameter. The value used for this API: DescribeWordSamples. |
| 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 | No | Array of String | Keyword use case filter. 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; Multiple elements can be selected, and the relationship between them is "OR", i.e., any keyword use case that contains any element in this field set will be deemed eligible. |
| Keywords.N | No | Array of String | Keyword filter. Array length limit: 100 words. |
| Tags.N | No | Array of String | Tag filter. Array length limit: 20 words. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of entries to be returned. Default value: 100. Maximum value: 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 |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| WordSet | Array of AiSampleWord | Keyword information. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to traverse the list of keywords with no filters.
https://vod.tencentcloudapi.com/?Action=DescribeWordSamples
&<Public request parameters>{
"Response": {
"TotalCount": 2,
"WordSet": [
{
"Keyword": "John Smith",
"TagSet": [
"Celebrity",
"Artist"
],
"Usages": [
"Recognition.Ocr",
"Recognition.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z"
},
{
"Keyword": "Jane Smith",
"TagSet": [
"President"
],
"Usages": [
"Review.Ocr",
"Review.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z"
}
],
"RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
}
}This example shows you how to keyword samples with filters such as the specified use case.
https://vod.tencentcloudapi.com/?Action=DescribeWordSamples
&Usages.0=Recognition
&Usages.1=Review.Ocr
&Keywords.0=John Smith
&Tags.0=Celebrity
&Offset=0
&Limit=20
&<Public request parameters>{
"Response": {
"TotalCount": 1,
"WordSet": [
{
"Keyword": "John Smith",
"TagSet": [
"Celebrity",
"Artist"
],
"Usages": [
"Recognition.Ocr",
"Recognition.Asr"
],
"CreateTime": "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 | Incorrect parameter value. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?