Domain name for API request: vod.intl.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 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. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created). |
| Usages.N | No | Array of String | Keyword application scenario filtering conditions, available values: 1. Recognition.Ocr: Perform content recognition using OCR. 2. Recognition.Asr: Perform content recognition using audio recognition technology. 3. Review.Ocr: Perform inappropriate content recognition using OCR. 4. Review.Asr: Perform inappropriate content recognition through audio recognition technology. Can be abbreviated as: 5. Recognition: Perform content recognition using 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. Multiple selections allowed. The relationship between elements is OR, meaning records where the keyword's application scenario includes any element in the field collection meet the condition. |
| Keywords.N | No | Array of String | Keyword filtering conditions. The array can contain up to 100 keywords. |
| 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 qualified records. |
| 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. |
This example shows you how to traverse the keyword list with no filters.
https://vod.intl.tencentcloudapi.com/?Action=DescribeWordSamples
&<Common request parameters>
{
"Response": {
"TotalCount": 2,
"WordSet": [
{
"Keyword": "John Smith",
"TagSet": [
"Celebrity",
"Artist"
],
"UsageSet": [
"Recognition.Ocr",
"Recognition.Asr"
],
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
},
{
"Keyword": "Jane Smith",
"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"
}
}
This example shows you how to query keywords with filters such as specified usage.
https://vod.intl.tencentcloudapi.com/?Action=DescribeWordSamples
&Usages.0=Recognition
&Usages.1=Review.Ocr
&Keywords.0=John Smith
&Tags.0=Celebrity
&Offset=0
&Limit=20
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"WordSet": [
{
"Keyword": "John Smith",
"TagSet": [
"Celebrity",
"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. |
피드백