Queries custom intervention dictionaries.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/intervention-dictionaries HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
pageSize Integer Query No 10

The number of entries to return on each page. Default value: 10.

pageNumber Integer Query No 1

The number of the page to return. Default value: 1.

types String Query No -

The types of the intervention dictionaries that you want to query.

Format: urlencode(["synonym", "stopword"])

Response parameters

Parameter Type Example Description
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

The ID of the request.

result Array of result

The information about each intervention dictionary.

For more information, see InterventionDictionary.

analyzer String ""

The custom analyzer.

created Integer 1539158325

The time when the intervention dictionary was created.

id Integer 1

The ID of the intervention dictionary.

name String tongyici

The name of the intervention dictionary.

type String synonym

The type of the intervention dictionary. Valid values:

  • stopword: an intervention dictionary for stop word filtering
  • synonym: an intervention dictionary for synonym configuration
  • correction: an intervention dictionary for spelling correction
  • category_prediction: an intervention dictionary for category prediction
  • ner: an intervention dictionary for named entity recognition (NER)
  • term_weighting: an intervention dictionary for term weight analysis
updated Integer 1539158313

The time when the intervention dictionary was last updated.

totalCount Integer 2

The total number of entries returned.


Sample requests

GET /v4/openapi/intervention-dictionaries

Sample success responses

XML format


JSON format

    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "totalCount": 2,
    "result": [
            "id": 1,
            "name": "tongyici",
            "type": "synonym",
            "analyzer": "",
            "created": 1539158313,
            "updated": 1539158313
            "id": 2,
            "name": "tingyongci",
            "type": "stopword",
            "analyzer": "",
            "created": 1539158325,
            "updated": 1539158325

Error codes

For a list of error codes, visit the API Error Center.