Queries the result of named entity recognition (NER).

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]/ner-results HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
name String Path Yes my_dict

The name of the intervention dictionary.

query String Query Yes Soymilk

The search query.

Response parameters

Parameter Type Example Description
requestId String 8F780CA8-D4D4-2FFE-B8AC-42040822C554

The ID of the request.

result Array of nerItem

The NER result.

For more information, see InterventionDictionaryEntry.

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 Soy

The entity.

Examples

Sample requests

GET /v4/openapi/intervention-dictionaries/ner_dict11/ner-results?query=aaaa

Sample success responses

XML format

<requestId>8F780CA8-D4D4-2FFE-B8AC-42040822C554</requestId>
<result>
    <tag>common</tag>
    <tagLabel>Common word</tagLabel>
    <token>aaaa</token>
    <order>1</order>
</result>

JSON format

{
    "requestId": "8F780CA8-D4D4-2FFE-B8AC-42040822C554",
    "result": {
        "tag": "common",
        "tagLabel": "Common word",
        "token": "aaaa",
        "order": 1
    }
}

Error codes

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