ListInterventionDictionaryNerResults - OpenSearch - Alibaba Cloud Documentation Center

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}/ner-results 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
query	string	Yes	The keyword to search for.	soy milk

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	8F780CA8-D4D4-2FFE-B8AC-42040822C554
result	array<object>	The NER results. For more information, see Named Entity Recognition (NER).
	object
tag	string	The tag of the detected entity. brand: Brand category: Category material: Material element: Element style: Style color: Color function: Function scenario: Scenario people: People season: Season model: Model region: Region name: Name adjective: Adjective category-modifier: Category modifier size: Size quality: Quality suit: Suit new-release: New release series: Series marketing: Marketing entertainment: Entertainment organization: Organization movie: Movie game: Game number: Number unit: Unit common: Common word new-word: New word proper-noun: Proper noun symbol: Symbol prefix: Prefix suffix: Suffix gift: Gift negative: Negative agent: Agent	category
token	string	The detected entity.	milk
order	integer	The ordinal number.	1
tagLabel	string	The label of the tag.	品类

Examples

Success response

JSON format

{
  "requestId": "8F780CA8-D4D4-2FFE-B8AC-42040822C554",
  "result": [
    {
      "tag": "category",
      "token": "milk",
      "order": 1,
      "tagLabel": "品类"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.