Automate Search Customization with the Intervention Dictionary API - OpenSearch - Alibaba Cloud - OpenSearch

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

opensearch:WriteInterventionDictionary

create

*InterventionDictionary

acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/*

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 a dry run to validate the request parameters. Default value: false. Valid values: true: Only validates the request parameters. false: Validates the request parameters and creates the intervention dictionary.	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. stopword: stop word filtering synonym: synonym configuration correction: spelling correction category_prediction: category prediction ner: Named Entity Recognition term_weighting: term weighting suggest_allowlist: drop-down suggestion whitelist suggest_denylist: drop-down suggestion blacklist hot_allowlist: top search whitelist hot_denylist: top search blacklist hint_allowlist: hint whitelist hint_denylist: hint blacklist	ner
analyzerType	string	No	The analyzer type. Valid values: MODEL: Model-based custom analyzer. SYSTEM: System analyzer. USER: Custom analyzer.	SYSTEM

Request body

Field	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 custom tokenizer. This parameter is required when type is set to ner.
analyzerType	String	No	"SYSTEM"	The analyzer type.

Reference: InterventionDictionary

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	80326EFE-485F-46E7-B291-5A1DD08D2198
result	object	The details of the intervention dictionary.
created	string	The time when the intervention dictionary was created.	1591086323
updated	string	The time when the intervention dictionary was last updated.	1591086323
type	string	The type of the intervention dictionary. stopword: stop word filtering synonym: synonym configuration correction: spelling correction category_prediction: category prediction ner: Named Entity Recognition term_weighting: term weighting suggest_allowlist: drop-down suggestion whitelist suggest_denylist: drop-down suggestion blacklist hot_allowlist: top search whitelist hot_denylist: top search blacklist hint_allowlist: hint whitelist hint_denylist: hint blacklist	ner
name	string	The name of the intervention dictionary.	testb
id	integer
analyzerType	string
analyzer	string	The custom tokenizer.	dianshang

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.