QueryProcessor

Updated at:

This topic describes the data structure of QueryProcessor.

Description

The query intent and understanding rules of an OpenSearch application version.

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 rule.

domain

String

The industry type. Valid values: GENERAL (general), ECOMMERCE (e-commerce), and IT_CONTENT (IT content).

processors[]

Object

The features included. For more information, see the Processor section below.

indexes

Array

The indexes to which the rule applies.

active

Boolean

Specifies whether the rule is the default rule.

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 words), spell_check (spelling check), term_weighting (term weight), synonym (synonyms), category_prediction (category prediction), and ner (named entity recognition).

use_system_dictionary

Boolean

Specifies whether to use the built-in system dictionary.

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: category_prediction (category prediction).

categoryPrediction

Integer

The ID of the category prediction model.

projectId

Integer

The ID of the algorithm project.

Named entity recognition

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: ner (named entity recognition).

use_system_dictionary

Boolean

Specifies whether to use the built-in system dictionary.

intervention_dictionary

String

The name of the intervention dictionary.

priorities[]

Object

The importance settings of entity types.

priorities[].priority

String

The importance. Valid values: HIGH, MIDDLE, and LOW.

priorities[].tag

String

The internal English representation of the entity type.

priorities[].order

Integer

The sort order within the same priority. Entity types are sorted by this number in ascending order. Default value: 0.