Queries the recommended priority settings of entity types for 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/query-processor/ner/default-priorities HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
domain String Query Yes ECOMMERCE

The type of the industry.

  • You can set the parameter only to ECOMMERCE, which indicates the e-commerce industry

Response parameters

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

The ID of the request.

result Array of result

The priority settings of entity types.

For more information, see Priority settings of entity types.

label String Brand

The name of the entity type.

order Integer 1

The priority of an entity type among entity types that have the same priority level.

A smaller value indicates a higher priority. Default value: 0.

priority String HIGH

The priority level of the entity type.

  • HIGH
  • MIDDLE
  • LOW
tag String brand

The internal name of the entity type.

Examples

Sample requests

GET /v4/openapi/query-processor/ner/default-priorities?domain=ECOMMERCE

Sample success responses

XML format

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <tag>brand</tag>
    <priority>HIGH</priority>
    <order>1</order>
    <label>Brand</label>
</result>
<result>
    <tag>category</tag>
    <priority>HIGH</priority>
    <order>2</order>
    <label>Category</label>
</result>
<result>
    <tag>material</tag>
    <priority>MIDDLE</priority>
    <order>3</order>
    <label>Material</label>
</result>
<result>
    <tag>element</tag>
    <priority>MIDDLE</priority>
    <order>4</order>
    <label>Fashion element</label>
</result>
<result>
    <tag>style</tag>
    <priority>MIDDLE</priority>
    <order>5</order>
    <label>Style</label>
</result>
<result>
    <tag>color</tag>
    <priority>MIDDLE</priority>
    <order>6</order>
    <label>Color</label>
</result>
<result>
    <tag>function</tag>
    <priority>MIDDLE</priority>
    <order>7</order>
    <label>Feature</label>
</result>
<result>
    <tag>scenario</tag>
    <priority>MIDDLE</priority>
    <order>8</order>
    <label>Scene</label>
</result>
<result>
    <tag>people</tag>
    <priority>MIDDLE</priority>
    <order>9</order>
    <label>Crowd</label>
</result>
<result>
    <tag>season</tag>
    <priority>MIDDLE</priority>
    <order>10</order>
    <label>Season</label>
</result>
<result>
    <tag>model</tag>
    <priority>MIDDLE</priority>
    <order>11</order>
    <label>Model</label>
</result>
<result>
    <tag>region</tag>
    <priority>MIDDLE</priority>
    <order>12</order>
    <label>Location</label>
</result>
<result>
    <tag>name</tag>
    <priority>MIDDLE</priority>
    <order>13</order>
    <label>Personal name</label>
</result>
<result>
    <tag>adjective</tag>
    <priority>MIDDLE</priority>
    <order>14</order>
    <label>Modifier</label>
</result>
<result>
    <tag>category-modifier</tag>
    <priority>MIDDLE</priority>
    <order>15</order>
    <label>Category-related modifier</label>
</result>
<result>
    <tag>size</tag>
    <priority>LOW</priority>
    <order>16</order>
    <label>Size</label>
</result>
<result>
    <tag>quality</tag>
    <priority>LOW</priority>
    <order>17</order>
    <label>Quality</label>
</result>
<result>
    <tag>suit</tag>
    <priority>LOW</priority>
    <order>18</order>
    <label>Suit</label>
</result>
<result>
    <tag>new-release</tag>
    <priority>LOW</priority>
    <order>19</order>
    <label>New product</label>
</result>
<result>
    <tag>series</tag>
    <priority>LOW</priority>
    <order>20</order>
    <label>Series</label>
</result>
<result>
    <tag>marketing</tag>
    <priority>LOW</priority>
    <order>21</order>
    <label>Marketing service</label>
</result>
<result>
    <tag>entertainment</tag>
    <priority>LOW</priority>
    <order>22</order>
    <label>Entertainment, book, and music</label>
</result>
<result>
    <tag>organization</tag>
    <priority>LOW</priority>
    <order>23</order>
    <label>Organization</label>
</result>
<result>
    <tag>movie</tag>
    <priority>LOW</priority>
    <order>24</order>
    <label>Movie or television name</label>
</result>
<result>
    <tag>game</tag>
    <priority>LOW</priority>
    <order>25</order>
    <label>Game name</label>
</result>
<result>
    <tag>number</tag>
    <priority>LOW</priority>
    <order>26</order>
    <label>Number</label>
</result>
<result>
    <tag>unit</tag>
    <priority>LOW</priority>
    <order>27</order>
    <label>Unit</label>
</result>
<result>
    <tag>common</tag>
    <priority>LOW</priority>
    <order>28</order>
    <label>Common word</label>
</result>
<result>
    <tag>new-word</tag>
    <priority>LOW</priority>
    <order>29</order>
    <label>New word</label>
</result>
<result>
    <tag>proper-noun</tag>
    <priority>LOW</priority>
    <order>30</order>
    <label>Proper noun</label>
</result>
<result>
    <tag>symbol</tag>
    <priority>LOW</priority>
    <order>31</order>
    <label>Symbol</label>
</result>
<result>
    <tag>prefix</tag>
    <priority>LOW</priority>
    <order>32</order>
    <label>Prefix</label>
</result>
<result>
    <tag>suffix</tag>
    <priority>LOW</priority>
    <order>33</order>
    <label>Suffix</label>
</result>
<result>
    <tag>gift</tag>
    <priority>LOW</priority>
    <order>34</order>
    <label>Present</label>
</result>
<result>
    <tag>negative</tag>
    <priority>LOW</priority>
    <order>35</order>
    <label>Negative</label>
</result>
<result>
    <tag>agent</tag>
    <priority>LOW</priority>
    <order>36</order>
    <label>Agent</label>
</result>

JSON format

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": [
        {
            "tag": "brand",
            "priority": "HIGH",
            "order": 1,
            "label": "Brand"
        },
        {
            "tag": "category",
            "priority": "HIGH",
            "order": 2,
            "label": "Category"
        },
        {
            "tag": "material",
            "priority": "MIDDLE",
            "order": 3,
            "label": "Material"
        },
        {
            "tag": "element",
            "priority": "MIDDLE",
            "order": 4,
            "label": "Fashion element"
        },
        {
            "tag": "style",
            "priority": "MIDDLE",
            "order": 5,
            "label": "Style"
        },
        {
            "tag": "color",
            "priority": "MIDDLE",
            "order": 6,
            "label": "Color"
        },
        {
            "tag": "function",
            "priority": "MIDDLE",
            "order": 7,
            "label": "Feature"
        },
        {
            "tag": "scenario",
            "priority": "MIDDLE",
            "order": 8,
            "label": "Scene"
        },
        {
            "tag": "people",
            "priority": "MIDDLE",
            "order": 9,
            "label": "Crowd"
        },
        {
            "tag": "season",
            "priority": "MIDDLE",
            "order": 10,
            "label": "Season"
        },
        {
            "tag": "model",
            "priority": "MIDDLE",
            "order": 11,
            "label": "Model"
        },
        {
            "tag": "region",
            "priority": "MIDDLE",
            "order": 12,
            "label": "Location"
        },
        {
            "tag": "name",
            "priority": "MIDDLE",
            "order": 13,
            "label": "Personal name"
        },
        {
            "tag": "adjective",
            "priority": "MIDDLE",
            "order": 14,
            "label": "Modifier"
        },
        {
            "tag": "category-modifier",
            "priority": "MIDDLE",
            "order": 15,
            "label": "Category-related modifier"
        },
        {
            "tag": "size",
            "priority": "LOW",
            "order": 16,
            "label": "Size"
        },
        {
            "tag": "quality",
            "priority": "LOW",
            "order": 17,
            "label": "Quality"
        },
        {
            "tag": "suit",
            "priority": "LOW",
            "order": 18,
            "label": "Suit"
        },
        {
            "tag": "new-release",
            "priority": "LOW",
            "order": 19,
            "label": "New product"
        },
        {
            "tag": "series",
            "priority": "LOW",
            "order": 20,
            "label": "Series"
        },
        {
            "tag": "marketing",
            "priority": "LOW",
            "order": 21,
            "label": "Marketing service"
        },
        {
            "tag": "entertainment",
            "priority": "LOW",
            "order": 22,
            "label": "Entertainment, book, and music"
        },
        {
            "tag": "organization",
            "priority": "LOW",
            "order": 23,
            "label": "Organization"
        },
        {
            "tag": "movie",
            "priority": "LOW",
            "order": 24,
            "label": "Movie or television name"
        },
        {
            "tag": "game",
            "priority": "LOW",
            "order": 25,
            "label": "Game name"
        },
        {
            "tag": "number",
            "priority": "LOW",
            "order": 26,
            "label": "Number"
        },
        {
            "tag": "unit",
            "priority": "LOW",
            "order": 27,
            "label": "Unit"
        },
        {
            "tag": "common",
            "priority": "LOW",
            "order": 28,
            "label": "Common word"
        },
        {
            "tag": "new-word",
            "priority": "LOW",
            "order": 29,
            "label": "New word"
        },
        {
            "tag": "proper-noun",
            "priority": "LOW",
            "order": 30,
            "label": "Proper noun"
        },
        {
            "tag": "symbol",
            "priority": "LOW",
            "order": 31,
            "label": "Symbol"
        },
        {
            "tag": "prefix",
            "priority": "LOW",
            "order": 32,
            "label": "Prefix"
        },
        {
            "tag": "suffix",
            "priority": "LOW",
            "order": 33,
            "label": "Suffix"
        },
        {
            "tag": "gift",
            "priority": "LOW",
            "order": 34,
            "label": "Present"
        },
        {
            "tag": "negative",
            "priority": "LOW",
            "order": 35,
            "label": "Negative"
        },
        {
            "tag": "agent",
            "priority": "LOW",
            "order": 36,
            "label": "Agent"
        }
    ]
}

Error codes

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