Domain name for API request: mps.tencentcloudapi.com.
This API is used to perform paged 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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Keywords.N | No | Array of String | Keyword filter. Array length limit: 100 words. |
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 usage contains any element in this parameter, the keyword sample will be used. |
Tags.N | No | Array of String | Tag filter. Array length limit: 20 words. |
Offset | No | Integer | Paging offset. Default value: 0. |
Limit | No | Integer | Number of returned entries. Default value: 100. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. Note: This field may return null, indicating that no valid values can be obtained. |
WordSet | Array of AiSampleWord | Keyword information. Note: This field may return null, indicating that no valid values can be obtained. |
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://mps.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://mps.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 |
---|---|
FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameterValue | Incorrect parameter value. |
Was this page helpful?