All Products
Search
Document Center

Intelligent Media Services:UpdateHotwordLibrary

Last Updated:Dec 23, 2025

Modifies a specified hotword library, including its name, description, and hotword list.

Operation description

  • You can call this operation to modify a specified hotword library.
  • The hotword library ID (HotwordLibraryId) is required to identify the library that requires modification.
  • You can modify its name (Name ), description (Description ), and hotword list (HotWords).
  • Each hotword in the list can also be modified, including its content (Text), weight (Weight), language (Language), and translation results (TranspositionResultList).
  • A single account supports up to 100 hotword libraries, each containing a maximum of 300 hotword entries. In a library, the combination of language and text of an entry must be unique. The combination of TranslatedText and TargetLanguage in TranspositionResultList must also be unique.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:UpdateHotwordLibraryupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The name of the hotword library. It can be up to 100 characters in length.

my_hotwords
DescriptionstringNo

The description of the hotword library. It can be up to 200 characters in length.

HotwordsarrayNo

The hotword list. You can add up to 300 hotword entries to a single library.

HotwordNo

The hotword information.

HotwordLibraryIdstringYes

The ID of the hotword library.

*a0052ff71efbfd4e7e6c66*

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

*3B-0E1A-586A-AC29-742247*
Successstring

The ID of the hotword library.

****96e8864746a0b6f3****

Examples

Sample success responses

JSONformat

{
  "RequestId": "*3B-0E1A-586A-AC29-742247*",
  "Success": "****96e8864746a0b6f3****"
}

Error codes

For a list of error codes, visit the Service error codes.