Managing Query Pipeline Rules From Tabs

Members of the Administrators and Relevance Managers built-in groups can manage Thesaurus, 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 Cloud 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 Edit a <RULE_TYPE> Rule dialog, 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 More, and then select 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 More, and then select Select condition or Change condition.

  3. In the Select a Condition panel that appears:

    1. Select an appropriate existing condition to apply.

      When there are many conditions, in the filter box, type a word from the condition you’re looking for to refine the list of displayed conditions.

      OR

      When the desired condition doesn’t yet exist, click Add condition to create a condition (see Create a Condition).

      • Below the condition list, click 10 or 100 to set the number of conditions per page. By default, the table shows 10 conditions per page. You can also click the left and right arrow icons, or a page number to navigate through condition pages.

      • If you find issues in the list of conditions, you can click Manage Conditions to go to the Conditions page where you can manage all conditions in your Coveo Cloud organization (see Adding and Managing Query Pipeline Conditions).

    2. (When you created a condition only) Select the condition you just created.

    3. Click Select condition or Save.

      Be aware that the condition is now effective.

Remove the Condition of a Rule

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

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

  3. In the Select a Condition dialog, under Selected condition, click Delete next to the selected condition.

  4. Click Save.

    The condition removal is now effective.

Add or Edit a Rule Note

  1. In the pipeline component tab, click the rule to which you want to add a note.

  2. In the Action bar, click More, and then select Set user note.

  3. In the Set a User Note dialog, enter a text with information that will 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

The following table indicates the required privileges to view or edit elements of the Query Pipelines page and associated panels (see Privilege Management 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