All Products
Search
Document Center

OpenSearch:QueryProcessor

Last Updated:Feb 20, 2023

Description

The information about a query analysis rule of an OpenSearch application.

Example

{
    "name": "qp_lsh_test_1",
    "domain": "GENERAL",
    "processors": [{
        "name": "stop_word",
        "use_system_dictionary": true,
        "intervention_dictionary": ""
    }],
    "indexes": [
        "default"
    ],
    "active": true
}

Structure

Field

Type

Description

name

String

The name of the query analysis rule. The name can contain digits, lowercase letters, and underscores (_), and must start with a lowercase letter. It can cannot exceed 16 characters in length.

domain

String

The type of the industry to which the query analysis rule applies. Valid values: GENERAL, ECOMMERCE, and IT_CONTENT.

processors[]

Object

The features that are used in the query analysis rule. For more information about the structure of the data about a feature, see the "Processor" section of this topic.

indexes

Array

The indexes to which the query analysis rule applies.

active

Boolean

Indicates whether the query analysis rule is the default one.

Processor

Example

{
        "name": "stop_word",
        "use_system_dictionary": true,
        "intervention_dictionary": ""
}

Structure

Field

Type

Description

name

String

The name of the feature. Valid values:

- stop_word: stop word filtering

- spell_check: spelling correction

- term_weighting: term weight analysis

- synonym: synonym configuration

- category_prediction: category prediction

- ner: named entity recognition (NER)

use_system_dictionary

Boolean

Indicates whether built-in dictionaries are used.

intervention_dictionary

String

The name of the intervention dictionary.

Category prediction

Example

{
        "name": "stop_word",
        "categoryPrediction": 12345,
        "projectId": 12346
}

Structure

Field

Type

Description

name

String

The name of the feature. A value of category_prediction indicates category prediction.

categoryPrediction

Integer

The ID of the category prediction model.

projectId

Integer

The ID of the algorithm project.

NER

Example

{
    "name": "stop_word",
    "use_system_dictionary": true,
    "intervention_dictionary": "",
    "priorities": [{
        "priority": "HIGH",
        "tag": "test",
        "order": 1
    }]
}

Structure

Field

Type

Description

name

String

The name of the feature. A value of ner indicates NER.

use_system_dictionary

Boolean

Indicates whether built-in dictionaries are used.

intervention_dictionary

String

The name of the intervention dictionary.

priorities[]

Object

The priority settings of entity types.

priorities[].priority

String

The priority level. Valid values: HIGH, MIDDLE, and LOW.

priorities[].tag

String

The internal name of the entity type.

priorities[].order

Integer

The priority of an entity type among entity types that have the same priority level. Default value: 0. A smaller value indicates a higher priority.