All Products
Search
Document Center

OpenSearch:ListInterventionDictionaryEntries

Last Updated:Mar 03, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:DescribeInterventionDictionary
  • InterventionDictionary
    acs:opensearch:{#regionId}:{#accountId}:intervention-dictionaries/{#InterventionDictionaryId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
namestringYes

my_dict

my_dict
wordstringNo

Test

pageNumberintegerNo

1

1
pageSizeintegerNo

10

10

Response parameters

ParameterTypeDescriptionExample
object
totalCountinteger

The total number of entries returned.

8
requestIdstring

The ID of the request.

516A02B7-2167-8D92-12D0-B639A2A0F3C5
resultobject []

The information about each intervention entry.

For more information, see InterventionDictionaryEntry .

cmdstring

The action. Valid values:

  • add
  • delete
add
createdlong

The timestamp when the intervention entry was created.

1536690285
wordstring

The intervention query in the intervention entry.

\u8fc7\u513f
relevanceobject

The content of an intervention entry for category prediction.

The parameter returns 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 value of 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" }
statusstring

The status of the intervention entry. Valid value:

  • ACTIVE: The intervention entry takes effect.
ACTIVE
updatedlong

The timestamp when the intervention entry was last updated.

1537348987
tokensobject []

The content of an intervention entry for term weight analysis.

tagstring

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
tokenstring

The entity.

orderinteger

The sequence number.

1
tagLabelstring

The description of the internal name of the identified entity type.

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history