Query Intervention Dictionary Entries via API with Pagination - OpenSearch

Queries the intervention entries in an intervention dictionary.

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:DescribeInterventionDictionary

*InterventionDictionary

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

None

Request syntax

GET /v4/openapi/intervention-dictionaries/{name}/entries HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the intervention dictionary.	my_dict

Request parameters

Parameter	Type	Required	Description	Example
word	string	No	The intervention entry.	test
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries returned per page. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
totalCount	integer	The total number of entries returned.	8
requestId	string	The request ID.	516A02B7-2167-8D92-12D0-B639A2A0F3C5
result	array<object>	The information about intervention entries. For more information, see InterventionDictionaryEntry.
	array<object>
cmd	string	The command. Valid values: add delete	add
created	integer	The timestamp when the intervention entry was created.	1536690285
word	string	The intervention entry.	\u8fc7\u513f
relevance	object	The content of an intervention entry for category prediction. The field value consists of key-value pairs. The key in a key-value pair indicates the ID of the category. The value in a key-value pair indicates the relevance to the category. A value of 0 indicates irrelevant. A value of 1 indicates slightly relevant. A value of 2 indicates relevant. Example: {"2":1, "100":0}	{ "100": "0", "200": "2" }
status	string	The status of the intervention entry. Valid value: ACTIVE: The intervention entry takes effect.	ACTIVE
updated	integer	The timestamp when the intervention entry was last updated.	1537348987
tokens	array<object>	The content of the intervention entry for term weight analysis.
	object
tag	string	The internal name of the identified entity type. Valid values: brand category material element style color function scenario people season model region name adjective category-modifier size quality suit new-release series marketing entertainment organization movie game number unit common new-word proper-noun symbol prefix suffix gift negative agent	category
token	string	The entity.	this
order	integer	The sequence number.	1
tagLabel	string	The description of the internal name of the identified entity type.	category

Examples

Success response

JSON format

{
  "totalCount": 8,
  "requestId": "516A02B7-2167-8D92-12D0-B639A2A0F3C5",
  "result": [
    {
      "cmd": "add",
      "created": 1536690285,
      "word": "\\u8fc7\\u513f",
      "relevance": {
        "100": "0",
        "200": "2"
      },
      "status": "ACTIVE",
      "updated": 1537348987,
      "tokens": [
        {
          "tag": "category",
          "token": "this",
          "order": 1,
          "tagLabel": "category"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.