DescribeWordSamples

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-01-21 11:42:35

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 usage. Valid values: 1. Recognition.Ocr: OCR-based content recognition 2. Recognition.Asr: ASR-based content recognition 3. Review.Ocr: OCR-based inappropriate information recognition 4. Review.Asr: ASR-based inappropriate information recognition Valid values can also be: 5. Recognition: ASR- and OCR-based content recognition; equivalent to 1+2 6. Review: ASR- and OCR-based inappropriate information recognition; equivalent to 3+4 You can select multiple elements, which are connected by OR logic. If a use case contains any element in this parameter, the keyword sample will be used.
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.

3. Output Parameters

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.

4. Example

Example1 Getting the list of keyword samples - with no filters

This example shows you how to traverse the list of keywords with no filters.

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeWordSamples
&<Common request parameters>

Output Example

{
  "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"
  }
}

Example2 Getting the list of keyword samples - with filters

This example shows you how to query a keyword sample with usages and other conditions specified.

Input Example

https://vod.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>

Output Example

{
  "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"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Recent Pages