International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Video on Demand
    Documentation
    Download PDF

    CreateWordSamples

    Last updated: 2021-01-21 11:42:38
    Download PDF

    1. API Description

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

    This API is used to create keyword samples in batches for using OCR and ASR technologies to perform video processing operations such as content recognition and inappropriate information recognition.

    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: CreateWordSamples.
    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 Yes 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
    7. All: ASR- and OCR-based content recognition and inappropriate information recognition; equivalent to 1+2+3+4
    Words.N Yes Array of AiSampleWordInfo Keyword. Array length limit: 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
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a keyword sample - Review

    If Usages=Review, then this keyword can be used for OCR- and ASR-based inappropriate information recognition.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=John Smith
&Words.0.Tags.0=Politically sensitive
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

    Example2 Creating a keyword sample - Recognition

    If Usages=["Recognition.Ocr","Review.Ocr"], then this keyword can be used for OCR-based content recognition and inappropriate information recognition.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Recognition.Ocr
&Usages.1=Review.Ocr
&Words.0.Keyword=Influencer
&Words.0.Tags.0=Entertainment
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

    Example3 Creating a keyword sample - All

    If Usages=All, then this keyword can be used for OCR- and ASR-based content recognition and inappropriate information recognition.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=Influencer
&Words.0.Tags.0=Entertainment
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

    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

    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.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy