UpdateHotwordLibrary-Intelligent Media Services(IMS)-阿里云帮助中心

Operation description

Request description

This operation allows you to update the information of an existing hotword library.
You must provide the hotword library ID (HotwordLibraryId), which is a required parameter.
You can simultaneously update the name (Name), description (Description), and hotword list (HotWords) of the hotword library.
For each hotword in the hotword list, you can set its text content (Text), weight (Weight), language (Language), and translation and transposition results (TranspositionResultList).
Note: You can create up to 100 hotword libraries under a single account, and add up to 300 hotwords to a single hotword library. Within a single hotword library, the combination of language and text for a hotword must be unique. In addition, within a single hotword library, the combination of TranslatedText and TargetLanguage in the TranspositionResultList of a hotword must also be unique.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:UpdateHotwordLibrary

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the hotword library. Maximum length: 100 characters.	my_hotwords
Description	string	No	The description of the hotword library. Maximum length: 200 characters.	Store the thesaurus of celebrities
Hotwords	array	No	The list of hotwords. Maximum length: 300 items.	Hotword library for celebrities
	Hotword	No	The hotword information.
HotwordLibraryId	string	Yes	The ID of the hotword library.	a0052ff71efbfd4e7e6c66

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	3B-0E1A-586A-AC29-742247
Success	string	The ID of the hotword library.	**96e8864746a0b6f3**

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.