Queries the information about an intervention dictionary.

Debugging

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/[name] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes my_dict

The name of the intervention dictionary.

Response parameters

Parameter Type Example Description
requestId String D7CCF454-472A-030E-F254-604520B028AA

The ID of the request.
result Struct

The information the intervention dictionary.
analyzer String -

The custom analyzer.
created String 1536233287

The time when the intervention dictionary was created.
name String test

The name of the intervention dictionary.
type String category_prediction

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 String 1536233287

The time when the intervention dictionary was last updated.

Examples

Sample requests

GET /v4/openapi/intervention-dictionaries/test

Sample success responses

XML format 

<requestId>D7CCF454-472A-030E-F254-604520B028AA</requestId>
<result>
    <name>test</name>
    <type>category_prediction</type>
    <analyzer/>
    <created>1536233287</created>
    <updated>1536233287</updated>
</result>

JSON format 

{
    "requestId": "D7CCF454-472A-030E-F254-604520B028AA",
    "result": {
        "name": "test",
        "type": "category_prediction",
        "analyzer": "",
        "created": 1536233287,
        "updated": 1536233287
    }
}

Error codes

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