Manage query pipeline rules

This is for:

Developer System Administrator

Members with the required privileges 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 Coveo (platform-ca | platform-eu | platform-au) 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 (platform-ca | platform-eu | platform-au) page, click the query pipeline for which you want to manage rules, and then click Edit components in the Action bar.

  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 click Edit in the Action bar.

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

  3. Click Save.

Duplicate a rule

In the pipeline component tab, click the rule you want to duplicate within the same pipeline (typically to create a slightly different rule), and then click Duplicate in the Action bar.

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

Note

With featured result and ranking expression query pipeline rules, you can select and duplicate up to 15 rules at a time.

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, and then click More > Edit code in the Action bar.

  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

Notes

  1. In the pipeline component tab, click the rule on which you want to add a condition or change the current applied one, and then click Edit in the Action bar.

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

  3. 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, and then click Edit in the Action bar.

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

  3. Click Save.

    The condition removal is now effective.

Add or edit a rule description

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

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

  3. Click Save.

    The entered text appears in the Description 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, and then click More > Copy to in the Action bar.

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

Important

The copied rule is effective immediately on the target pipeline.
Note

With featured result and ranking expression query pipeline rules, you can select and copy up to 15 rules at a time.

Delete a rule

  1. In the pipeline component tab, click the rule that you want to delete, and then click More > Delete in the Action bar.

  2. Click Delete to confirm.

Important

  • The deleted rule immediately ceases to be effective.

  • To avoid undesired search behaviors, we recommend that you delete unused query pipeline rules, as they can impact search relevance. Consider using the Groups & Campaigns feature to make query pipeline rules only apply for a specific time period.
Note

With featured result and ranking expression query pipeline rules, you can select and delete multiple rules at a time.

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, and then click Move up or Move down in the Action bar to change the position of the rule.

Required privileges

By default, members with the required privileges can view and edit elements of the Query Pipelines (platform-ca | platform-eu | platform-au) page.

The following table indicates the privileges required to view or edit elements of the Query Pipelines (platform-ca | platform-eu | platform-au) page (see Manage privileges and Privilege reference).

Action Service - Domain Required access level

View query pipeline

Organization - Organization
Search - Query pipelines
Machine Learning - Models

View

Edit query pipeline

Organization - Organization
Machine Learning - Models

View

Search - Query pipelines

Edit

View test search page

Search - Query pipeline preview

View