tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyWordSample

Last updated: 2024-03-27 16:10:08

    1. API Description

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

    This API is used to modify the use case and tag of a keyword. The keyword itself cannot be modified, but you can delete it and create another one if needed.

    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 Params. The value used for this API: ModifyWordSample.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Keyword Yes String Keyword. Length limit: 128 characters.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    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
    7. All: equivalent to 1+2+3+4
    TagOperationInfo No AiSampleTagOperation Tag operation information.

    3. Output Parameters

    Parameter Name Type Description
    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.

    4. Example

    Example1 Modifying a keyword sample

    Input Example

    https://vod.tencentcloudapi.com/?Action=ModifyWordSample
&Keyword=Fight
&Usages.0=Review
&TagOperationInfo.Type=reset
&TagOperationInfo.Tags.0="Terrorist information"
&<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.
    ResourceNotFound.Word The resource does not exist: keyword.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy