Queries the query analysis rules that are configured for a version of an OpenSearch application.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request parameters.
Request syntax
GET /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/query-processors HTTP/1.1Request parameters
| Parameter | Type | Position | Required | Example | Description |
|---|---|---|---|---|---|
| appGroupIdentity | String | Path | Yes | my_app_group_name |
The name of the application. |
| appId | Integer | Path | Yes | 110157886 |
The ID of the version. |
| isActive | Integer | Query | No | 0 |
Specifies the scope of query analysis rules to be queried. Default value: 0. Valid values:
|
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 query analysis rule. For more information, see QueryProcessor. |
|
| active | Boolean | true |
Indicates whether the query analysis rule is the default one. |
| created | Integer | 1587398402 |
The time when the query analysis rule was created. |
| domain | String | GENERAL |
The type of the industry. Valid values:
|
| indexes | List | [ "default" ] |
The indexes to which the query analysis rule applies. |
| name | String | ner |
The name of the query analysis rule. |
| processors | List | [] |
The features that are used in the query analysis rule. For more information, see the "Processor" section of the QueryProcessor topic. |
| updated | Integer | 1587398402 |
The time when the query analysis rule was last updated. |
Examples
Sample requests
GET /v4/openapi/app-groups/os_function_test_v1/apps/110157886/query-processorsSample success responses
XML format
<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
<name>test</name>
<active>true</active>
<indexes>default</indexes>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<name>ner</name>
<interventionDictionary/>
<priorities>
<tag>brand</tag>
<priority>HIGH</priority>
</priorities>
<priorities>
<tag>category</tag>
<priority>HIGH</priority>
</priorities>
<priorities>
<tag>material</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>element</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>style</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>color</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>function</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>scenario</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>people</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>season</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>model</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>region</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>name</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>adjective</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>category-modifier</tag>
<priority>MIDDLE</priority>
</priorities>
<priorities>
<tag>size</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>quality</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>suit</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>new-release</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>series</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>marketing</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>entertainment</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>organization</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>movie</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>game</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>number</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>unit</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>common</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>new-word</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>proper-noun</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>symbol</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>prefix</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>suffix</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>gift</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>negative</tag>
<priority>LOW</priority>
</priorities>
<priorities>
<tag>agent</tag>
<priority>LOW</priority>
</priorities>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<name>synonym</name>
<interventionDictionary/>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<name>term_weighting</name>
<interventionDictionary/>
</processors>
<processors>
<useSystemDictionary>true</useSystemDictionary>
<name>spell_check</name>
<interventionDictionary/>
</processors>
<processors>
<name>category_prediction</name>
<categoryPrediction>60</categoryPrediction>
<projectId>848</projectId>
</processors>
<domain>GENERAL</domain>
<created>1587398402</created>
<updated>1587398402</updated>
</result>JSON format
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": {
"name": "test",
"active": true,
"indexes": "default",
"processors": [
{
"useSystemDictionary": true,
"name": "ner",
"interventionDictionary": "",
"priorities": [
{
"tag": "brand",
"priority": "HIGH"
},
{
"tag": "category",
"priority": "HIGH"
},
{
"tag": "material",
"priority": "MIDDLE"
},
{
"tag": "element",
"priority": "MIDDLE"
},
{
"tag": "style",
"priority": "MIDDLE"
},
{
"tag": "color",
"priority": "MIDDLE"
},
{
"tag": "function",
"priority": "MIDDLE"
},
{
"tag": "scenario",
"priority": "MIDDLE"
},
{
"tag": "people",
"priority": "MIDDLE"
},
{
"tag": "season",
"priority": "MIDDLE"
},
{
"tag": "model",
"priority": "MIDDLE"
},
{
"tag": "region",
"priority": "MIDDLE"
},
{
"tag": "name",
"priority": "MIDDLE"
},
{
"tag": "adjective",
"priority": "MIDDLE"
},
{
"tag": "category-modifier",
"priority": "MIDDLE"
},
{
"tag": "size",
"priority": "LOW"
},
{
"tag": "quality",
"priority": "LOW"
},
{
"tag": "suit",
"priority": "LOW"
},
{
"tag": "new-release",
"priority": "LOW"
},
{
"tag": "series",
"priority": "LOW"
},
{
"tag": "marketing",
"priority": "LOW"
},
{
"tag": "entertainment",
"priority": "LOW"
},
{
"tag": "organization",
"priority": "LOW"
},
{
"tag": "movie",
"priority": "LOW"
},
{
"tag": "game",
"priority": "LOW"
},
{
"tag": "number",
"priority": "LOW"
},
{
"tag": "unit",
"priority": "LOW"
},
{
"tag": "common",
"priority": "LOW"
},
{
"tag": "new-word",
"priority": "LOW"
},
{
"tag": "proper-noun",
"priority": "LOW"
},
{
"tag": "symbol",
"priority": "LOW"
},
{
"tag": "prefix",
"priority": "LOW"
},
{
"tag": "suffix",
"priority": "LOW"
},
{
"tag": "gift",
"priority": "LOW"
},
{
"tag": "negative",
"priority": "LOW"
},
{
"tag": "agent",
"priority": "LOW"
}
]
},
{
"useSystemDictionary": true,
"name": "synonym",
"interventionDictionary": ""
},
{
"useSystemDictionary": true,
"name": "term_weighting",
"interventionDictionary": ""
},
{
"useSystemDictionary": true,
"name": "spell_check",
"interventionDictionary": ""
},
{
"name": "category_prediction",
"categoryPrediction": 60,
"projectId": 848
}
],
"domain": "GENERAL",
"created": 1587398402,
"updated": 1587398402
}
}Error codes
For a list of error codes, visit the API Error Center.