CreateInterventionDictionary - OpenSearch - Alibaba Cloud Documentation Center

Create an intervention dictionary.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:WriteInterventionDictionary		InterventionDictionary acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*	none	none

Request syntax

POST /v4/openapi/intervention-dictionaries HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Default value: false. Valid values: true false	false
body	object	No	The request body.
name	string	No	The name of the intervention dictionary.	ner_dict_ec
type	string	No	The type of the intervention dictionary. Valid values: stopword: an intervention dictionary for stop word filtering. synonym: an intervention dictionary for synonym configuration. correction: an intervention dictionary for spelling correction. category_prediction: an intervention dictionary for category prediction. ner: an intervention dictionary for named entity recognition (NER). term_weighting: an intervention dictionary for term weight analysis. suggest_allowlist: a drop-down suggestion whitelist. suggest_denylist: a drop-down suggestion blacklist. hot_allowlist: a top search whitelist. hot_denylist: a top search blacklist. hint_allowlist: a hint whitelist. hint_denylist: a hint blacklist.	ner
analyzerType	string	No	The type of the analyzer. Valid values: MODEL: model-based custom analyzer. SYSTEM: system analyzer. USER: custom analyzer.	SYSTEM

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"my_dict"	The name of the intervention dictionary.
type	String	Yes	"ner"	The type of the intervention dictionary.
analyzer	String	No	"my_analyzer"	The name of the custom analyzer. This parameter is required if type is set to ner.
analyzerType	String	No	"SYSTEM"	The type of the analyzer.

For more information, see InterventionDictionary .

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The ID of the request.	80326EFE-485F-46E7-B291-5A1DD08D2198
result	object	The returned results.
created	string	The time when the test scenario was created.	1591086323
analyzer	string	The custom analyzer.	dianshang
updated	string	The time when the intervention dictionary was last updated.	1591086323
type	string	The type of the intervention dictionary. Valid values: stopword: an intervention dictionary for stop word filtering synonym: an intervention dictionary for synonym configuration correction: an intervention dictionary for spelling correction category_prediction: an intervention dictionary for category prediction ner: an intervention dictionary for named entity recognition (NER) term_weighting: an intervention dictionary for term weight analysis	ner
name	string	The name of the test group.	testb

Examples

Sample success responses

JSONformat

{
  "requestId": "80326EFE-485F-46E7-B291-5A1DD08D2198",
  "result": {
    "created": "1591086323",
    "analyzer": "dianshang",
    "updated": "1591086323",
    "type": "ner",
    "name": "testb"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-24	The request parameters of the API has changed	View Change Details