Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The behaviour of the workflow is managed in the project configuration under the SETTINGS tab where you can configure the following settings:

Name

Value

Description

topic.search.query-workflow-enabled

false

true

Enable or disable query processing feature

topic.search.query-workflow

${workflow_id}

Set the value to the workflow_id of the ML-workflow you want to use for query processing. By default, the workflow_id is set to the ID of the pre-configured workflow that is setup upon project creation.

Remove if you want to disable query processing.

topic.search.query-workflow-mode

always

global

Modes for workflow execution:
global (recommended, requires Global Search Bar widget)

  • Executes query processing workflow once for the whole dashboard
    (triggered via Global Search Bar widget)

always

  • Execute workflow for every request to the /query endpoint.
    This mode is useful when Squirro is used as an API only.

...

The default query processing workflow cannot be deleted, but can be disabled. To disable performing query processing, you can navigate to the SETTINGS > Project Configuration andremove disable the topic.search.query-workflow-enabled option by clicking the RESET EDIT button and uncheck the checkbox.

Info

During the startup, the ML-Service automatically adds the default query processing workflow to the projects that don’t have it.

Because each project has its own default workflow, the default query processing workflow is not imported during project importing.

...

Expand
titlePre-configured query processing pipeline steps
Code Block
languagejson
{
    "cacheable": true,
    "dataset": {
        "items": []
    },
    "pipeline": [
        {
            "fields": ["query"],
            "step": "loader",
            "type": "squirro_item"
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "syntax_parser"
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "lang_detection",
            "fallback_language": "en"
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "custom_spacy_normalizer",
            "cache_document": true,
            "model_cache_expiration" : 180000,
            "infix_split_hyphen": false,
            "infix_split_chars": ":<>=",
            "merge_noun_chunks": false,
            "merge_phrases": true,
            "merge_entities": true,
            "fallback_language": "en",
            "exclude_spacy_pipes": [],
            "spacy_model_mapping": {
                "en": "en_core_web_sm",
                "de": "de_core_news_sm"
            },
            "struct_log_enable": true,
            "struct_log_name": "spacy-normalizer",
            "struct_log_input_step_fields": ["user_terms_str"]
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "pos_booster",
            "phrase_proximity_distance": 15,
            "pos_weight_map": {
                "PROPN": 10"-",
                "NOUN": 10"-",
                "VERB": 2"-",
                "ADJ": 5"-",
                "X": "-",
                "NUM": "-",
                "SYM": "-"
            }
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "lemma_tagger"
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "query_classifier",
            "model": "svm-query-classifier"
        },
        {
            "step": "app",
            "type": "query_processing",
            "name": "query_modifier"
        },
        {
            "step": "debugger",
            "type": "log_fields",
            "fields": [
                "user_terms",
                "facet_filters",
                "pos_mutations",
                "type",
                "enriched_query",
                "lemma_map"
            ],
            "log_level": "info"
        }
    ]
}

The workflow is set up to:

...

You can configure the steps of the query processing workflow in the UI in the ML Workflows plugin under the AI STUDIO tab.

How-to Guides

How-to Customize and Upload libNLP Workflow for customise Query Processing using custom Steps

How-to Install a SpaCy Language Model

...