DescribeAIRecognitionTemplates

Last updated: 2020-01-13 11:49:21

    1. API Description

    Domain name for API request: mps.tencentcloudapi.com.

    This API is used to get the list of content recognition templates based on unique template ID. The return result includes all eligible custom and preset content recognition templates.

    A maximum of 10 requests can be initiated per second for this API.

    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: DescribeAIRecognitionTemplates
    Version Yes String Common parameter. The value used for this API: 2019-06-12
    Region No String Common parameter. This parameter is not required for this API.
    Definitions.N No Array of Integer Unique ID filter of video content recognition templates. Array length limit: 10.
    Offset No Integer Paging offset. Default value: 0.
    Limit No Integer Number of returned entries. Default value: 10. Maximum value: 50.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible entries.
    AIRecognitionTemplateSet Array of AIRecognitionTemplateItem List of video content recognition template details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1

    Input Example

    https://mps.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
    &Definitions.0=30
    &<common request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "AIRecognitionTemplateSet": [
          {
            "Definition": 30,
            "Name": "Template1",
            "Comment": "AIRecognitionTemplate",
            "FaceConfigure": {
              "Switch": "ON",
              "FaceLibrary": "All",
              "LabelSet": []
            },
            "OcrFullTextConfigure": {
              "Switch": "ON"
            },
            "OcrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "AsrFullTextConfigure": {
              "Switch": "ON"
            },
            "AsrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "CreateTime": "2019-01-01T12:00:00Z",
            "UpdateTime": "2019-01-01T16:00:00Z"
          }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
      }
    }

    Example2

    Input Example

    https://mps.tencentcloudapi.com/?Action=DescribeAIRecognitionTemplates
    &Offset=0
    &Limit=10
    &<common request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 2,
        "AIRecognitionTemplateSet": [
          {
            "Definition": 30,
            "Name": "Template1",
            "Comment": "AIRecognitionTemplates",
            "FaceConfigure": {
              "Switch": "ON",
              "FaceLibrary": "All",
              "LabelSet": []
            },
            "OcrFullTextConfigure": {
              "Switch": "ON"
            },
            "OcrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "AsrFullTextConfigure": {
              "Switch": "ON"
            },
            "AsrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "CreateTime": "2019-01-01T12:00:00Z",
            "UpdateTime": "2019-01-01T16:00:00Z"
          },
          {
            "Definition": 31,
            "Name": "Template2",
            "Comment": "AIRecognitionTemplates",
            "FaceConfigure": {
              "Switch": "OFF",
              "FaceLibrary": "All",
              "LabelSet": []
            },
            "OcrFullTextConfigure": {
              "Switch": "OFF"
            },
            "OcrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "AsrFullTextConfigure": {
              "Switch": "OFF"
            },
            "AsrWordsConfigure": {
              "Switch": "OFF",
              "LabelSet": null
            },
            "CreateTime": "2019-01-01T11:00:00Z",
            "UpdateTime": "2019-01-01T12:00:00Z"
          }
        ],
        "RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

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

    Command Line Interface

    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.
    InvalidParameter Parameter error.
    InvalidParameterValue.Definitions Parameter error: Definitions.
    InvalidParameterValue.Limit Parameter error: Limit.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help