ListInterventionDictionaryEntries - OpenSearch - Alibaba Cloud Documentation Center

Queries the intervention entries in 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:DescribeInterventionDictionary		InterventionDictionary acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the intervention dictionary.	my_dict
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 parameters

Parameter	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 .
wordItem	object
cmd	string	The command. Valid values: add delete	add
created	long	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	long	The timestamp when the intervention entry was last updated.	1537348987
tokens	array<object>	The content of the intervention entry for term weight analysis.
token	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.	category
order	integer	The sequence number.	1
tagLabel	string	The description of the internal name of the identified entity type.	category

Examples

Sample success responses

JSONformat

{
  "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": "category",
          "order": 1,
          "tagLabel": "category"
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history