Manage Query Pipeline Rules

Members of the Administrators and Relevance Managers built-in groups can manage Thesaurus, Result Ranking, Featured Results, Ranking Expressions, Ranking Weights, Triggers, Filters, and Query Parameters rules associated with each query pipeline.

Query pipeline rules, along with Coveo Machine Learning (Coveo ML) models, optimize your search results relevance and general search experience.

Access the Tab of a Pipeline Component

  1. Log in to the Coveo Platform as a member of a group with the required privileges to manage query pipeline components in the target Coveo organization, if not already done.

  2. In the main menu on the left, under Search, select Query Pipelines.

  3. On the Query Pipelines page, click the query pipeline for which you want to manage rules, and then in the Action bar, click Edit components.

  4. On the query pipeline page, select the tab under which the rule you want to manage is located.

Modify a Rule

  1. In the pipeline component tab, click the rule to modify, and then in the Action bar, click Edit.

  2. In the dialog that appears, add or delete rule elements.

  3. Click Save.

Duplicate a Rule

  1. In the pipeline component tab, click the rule you want to duplicate within the same pipeline (typically to create a slightly different rule).

  2. In the Action bar, click Duplicate.

    The duplicated rule appears at the bottom of the list in the pipeline component tab.

Modify the Code of a Rule

  1. In the pipeline component tab, access the Edit a Rule With Code dialog:

    1. Click the rule you want to modify.

    2. In the Action bar, click More, and then select Edit code.

  2. In the Edit a Rule With Code dialog, make your modifications ensuring the rule still respects the query pipeline language syntax (see Query Pipeline Language (QPL)).

  3. Click Save.

Apply a Condition to a Rule

  1. In the pipeline component tab, click the rule on which you want to add a condition or change the current applied one.

  2. In the Action bar, click Edit.

  3. On the subpage that opens, under Condition, select an appropriate existing condition to apply or create a new one.

  4. Click Save.

Remove the Condition of a Rule

  1. In the pipeline component tab, click the rule on which you want to remove the associated condition.

  2. In the Action bar, click Edit.

  3. On the subpage that opens, under Condition, click Delete to remove the condition from the query pipeline rule.

  4. Click Save.

    The condition removal is now effective.

Add or Edit a Rule Note

  1. In the pipeline component tab, click on the desired note.

  2. In the Action bar, click Edit.

  3. Under User note, enter text with information that could help you and your colleagues to manage the rule in the future.

  4. Click Save.

    The entered text appears in the User Note column.

Copy a Rule to Another Pipeline

  • The Copy to option is only available when you have at least two query pipelines.

  • The condition (if any) for the rule to be applied is included in the copy.

  1. In the pipeline component tab, click the rule you want to copy.

  2. In the Action bar, click More, and then select Copy to.

  3. In the Copy To dialog, click the name of the pipeline to which you want to copy the rule.

    The copied rule is effective immediately on the target pipeline.

Delete a Rule

  1. In the pipeline component tab, click the rule that you want to delete.

  2. In the Action bar, click More, and then select Delete.

  3. Click Delete to confirm.

    The deleted rule immediately ceases to be effective.

Change the Rule Order

Query pipeline rules are executed in the order in which they appear on the page until a condition is satisfied.

To reorder query pipeline rules

  1. In the pipeline component tab, click the rule whose position you want to change.

  2. In the Action bar, click Move up or Move down to change the position of the rule.

Required Privileges

By default, members of the Administrators and Relevance Managers built-in groups can view and edit elements of the Query Pipelines page.

The following table indicates the required privileges to view or edit elements of the Query Pipelines page, and associated panels and subpages (see Manage Privileges and Privilege Reference).

Action Service - Domain Required access level
View rules and rule conditions

Search - Query pipelines

Machine Learning - Models

View
Add, edit, and delete query pipeline rules and rule conditions

Search - Query pipelines

Machine Learning - Models

Edit
Recommended Articles