Queries the intervention entries in 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]/entries HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes my_dict

The name of the intervention dictionary.
pageNumber Integer Query Yes 1

The number of the page to return. Default value: 1.
word String Query No Test

The intervention query in the intervention entry that you want to query.
pageSize Integer Query No 10

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

Response parameters

Parameter Type Example Description
requestId String 516A02B7-2167-8D92-12D0-B639A2A0F3C5

The ID of the request.
result Array of wordItem

The information about each intervention entry.

For more information, see InterventionDictionaryEntry.

cmd String add

The action. Valid values:

  • add
  • delete
created Long 1536690285

The timestamp when the intervention entry was created.
relevance Map { "100": "0", "200": "2" }

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}
status String ACTIVE

The status of the intervention entry. Valid value:

  • ACTIVE: The intervention entry takes effect.
tokens Array of token

The content of an intervention entry for term weight analysis.
order Integer 1

The sequence number.
tag String category

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
tagLabel String Category

The description of the internal name of the identified entity type.
token String Book

The entity.
updated Long 1537348987

The timestamp when the intervention entry was last updated.
word String \u8fc7\u513f

The intervention query in the intervention entry.
totalCount Integer 8

The total number of entries returned.

Examples

Sample requests

GET /v4/openapi/intervention-dictionaries/test/entries

Sample success responses

XML format 

<requestId>516A02B7-2167-8D92-12D0-B639A2A0F3C5</requestId>
<result>
    <cmd>add</cmd>
    <word>Yang Guo</word>
    <created>1536690285</created>
    <updated>1537348987</updated>
    <status>ACTIVE</status>
    <relevance>
        <100>0</100>
        <200>2</200>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>Guo</word>
    <created>1536690308</created>
    <updated>1537349055</updated>
    <status>ACTIVE</status>
    <relevance>
        <200>2</200>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>Apple</word>
    <created>1536683292</created>
    <updated>1537220498</updated>
    <status>ACTIVE</status>
    <relevance>
        <12>1</12>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>Umm</word>
    <created>1536690347</created>
    <updated>1537220498</updated>
    <status>ACTIVE</status>
    <relevance>
        <100>2</100>
        <200>0</200>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>Fruit</word>
    <created>1536690184</created>
    <updated>1537220498</updated>
    <status>ACTIVE</status>
    <relevance>
        <100>2</100>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>Pants</word>
    <created>1537353071</created>
    <updated>1537353074</updated>
    <status>ACTIVE</status>
    <relevance>
        <100>1</100>
        <200>2</200>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>adfads</word>
    <created>1536690258</created>
    <updated>1537220498</updated>
    <status>ACTIVE</status>
    <relevance>
        <1>1</1>
        <2>1</2>
        <3>1</3>
    </relevance>
</result>
<result>
    <cmd>add</cmd>
    <word>zvzcxv</word>
    <created>1536690537</created>
    <updated>1537220498</updated>
    <status>ACTIVE</status>
    <relevance>
        <100>1</100>
    </relevance>
</result>
<totalCount>8</totalCount>

JSON format 

{
    "requestId": "516A02B7-2167-8D92-12D0-B639A2A0F3C5",
    "result": [
        {
            "cmd": "add",
            "word": "Yang Guo",
            "created": 1536690285,
            "updated": 1537348987,
            "status": "ACTIVE",
            "relevance": {
                "100": 0,
                "200": 2
            }
        },
        {
            "cmd": "add",
            "word": "Guo",
            "created": 1536690308,
            "updated": 1537349055,
            "status": "ACTIVE",
            "relevance": {
                "200": 2
            }
        },
        {
            "cmd": "add",
            "word": "Apple",
            "created": 1536683292,
            "updated": 1537220498,
            "status": "ACTIVE",
            "relevance": {
                "12": 1
            }
        },
        {
            "cmd": "add",
            "word": "Umm",
            "created": 1536690347,
            "updated": 1537220498,
            "status": "ACTIVE",
            "relevance": {
                "100": 2,
                "200": 0
            }
        },
        {
            "cmd": "add",
            "word": "Fruit",
            "created": 1536690184,
            "updated": 1537220498,
            "status": "ACTIVE",
            "relevance": {
                "100": 2
            }
        },
        {
            "cmd": "add",
            "word": "Pants",
            "created": 1537353071,
            "updated": 1537353074,
            "status": "ACTIVE",
            "relevance": {
                "100": 1,
                "200": 2
            }
        },
        {
            "cmd": "add",
            "word": "adfads",
            "created": 1536690258,
            "updated": 1537220498,
            "status": "ACTIVE",
            "relevance": {
                "1": 1,
                "2": 1,
                "3": 1
            }
        },
        {
            "cmd": "add",
            "word": "zvzcxv",
            "created": 1536690537,
            "updated": 1537220498,
            "status": "ACTIVE",
            "relevance": {
                "100": 1
            }
        }
    ],
    "totalCount": 8
}

Error codes

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