Adding and Managing Query Pipelines

Administrators and relevance managers can use the Query Pipelines page in the administration console navigation menu to manage the thesaurus, featured result, stop word, ranking expression, ranking weight, and trigger rules as well as Coveo Machine Learning (Coveo ML) models of a Coveo Cloud organization (see What Is a Query Pipeline? and Built-In Groups). This allows you to optimize search results relevance and search experience in general.

If you are currently migrating your Coveo Cloud organization from V1 to V2, note that all actions regarding query pipelines (e.g., modification of a rule, creation of a query pipeline, etc.) in one organization will be effective in the other as well. However, this behavior does not apply to Coveo Machine Learning (Coveo ML) models.

In your live Coveo Cloud V1 organization, you create a new thesaurus rule to quickly address a content gap issue. This thesaurus rule will also appear in your Coveo Cloud organization.

If you leverage a feature that is only available in a Coveo Cloud organization, this feature will not be visible in your V1 organization.

In this article, the content relative to Coveo ML models applies only for Coveo Cloud organizations created prior to April 23, 2019 that did not go through the Coveo ML migration process. In other organizations, one must manage models directly from the Models page (see Adding and Managing Coveo Machine Learning Models).

Access the “Query Pipelines” Page

  1. If not already done, log in to the Coveo Cloud platform as a member of a group with the required privileges to manage query pipeline components in the target Coveo Cloud organization.

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

Create a Query Pipeline

  1. On the Query Pipelines page, click Add Pipeline.

    If the Add Pipeline button is grayed and unresponsive, you do not have all of the required privileges to perform this action.

  2. In the Add a Query Pipeline panel:

    1. In the Configuration tab, in the first box, enter a name for the query pipeline.

      This name appears as the title of your pipeline page and can be used to enforce the pipeline in the search token or in the search interface (see Query Pipeline Routing Mechanisms and Rules).

    2. In the User note box, optionally enter a description for the query pipeline to help administration console users understand its purpose.

      The entered text appears in the User note column.

    3. On the right-hand side of the panel, under Condition:

      • Select an appropriate existing condition to apply.

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

        OR

      • When the desired condition does not yet exist, click Create a new condition to add one (see Create a Condition).

  3. In the Access tab, use the Access level drop-down menus to determine whether each group in your organization can view or edit your query pipeline.

    Groups for which there is no drop-down menu in the Access Level column are either groups that can edit all query pipelines created in the organization or groups that are not allowed to see query pipelines at all (see Understanding Resource Access and Query Pipelines Domain). Since these groups’ access level for any new query pipeline is already determined, you have no decision to make regarding them in the Access tab.

    If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit your query pipeline once it is saved. Only administrators and members of other groups that have the Edit access level on this query pipeline will be able to do so. To keep your ability to edit this query pipeline, set the Access level to Edit for at least one of the groups of which you are a member.

  4. Click Add Pipeline.

Manage Query Pipelines

On the Query Pipelines page, you can:

Test a Query Pipeline in the Content Browser

  1. Click the query pipeline that you want to test.

  2. In the Action bar, click More, and then select Open in Content Browser.

On the Content Browser page, you can perform queries to validate the behavior of this specific pipeline.

Export Query Pipeline Rules and/or Models

  1. Click the query pipeline whose rules and/or models you want to export.

  2. In the Action bar, click More, and then select Import/Export.

  3. In the Import/Export dialog that appears, select the Export tab.

  4. In the Export tab, select the pipeline component(s) rules or models you want to export (All, Automatic relevance tuning, Event recommendations, Featured results, Filters, Query parameters, Query suggestions, Ranking expressions, Ranking weights, Stop words, Thesaurus, or Triggers).

    The data is exported to a CSV file in the Downloads folder of your browser.

Import Query Pipeline Rules and/or Models

  1. Click the query pipeline that you want to import rules and/or models in.

  2. In the Action bar, click More, and then select Import/Export.

  3. In the Import/Export dialog that appears:

    1. When you want to keep the existing query pipeline configuration, export existing rules and models (see Export query pipeline rules and/or models).

      Importing query pipeline rules and models in another query pipeline overwrites all its existing rules and models (if any).

    2. In the Import tab, click the drop-down menu, and then select one of the following pipeline component(s) from which import models (Automatic relevance tuning, Event recommendations, and Query suggestions) and/or rules:

      • All

        By default, all rules and all Coveo ML models from a pipeline are imported.

      • Automatic relevance tuning

      • Event recommendations

      • Featured results

      • Filters

      • Query parameters

      • Query suggestions

      • Ranking expressions

      • Ranking weights

      • Stop words

      • Thesaurus

      • Triggers

  4. Click Choose File.

  5. Select the CSV file containing the query pipeline rules and/or models, and then click Open.

  6. Click Import.

Set a Query Pipeline as the Default One

  1. Click the query pipeline that you want to set as the default one.

  2. In the Action bar, click More, and then select Set as default.

The Default (Default tag) tag appears in the Info column for this pipeline.

The default query pipeline is used when the condition of no other pipeline matches the query (see Query Pipeline Routing Mechanisms and Rules).

There is always one and only one pipeline configured as the default pipeline identified with the Default tag. You cannot remove the default pipeline without first setting another pipeline as the default pipeline.

Make sure that no condition is set on the default pipeline.

Remove the Condition on a Query Pipeline

  1. Access the Edit a Query Pipeline: [QPL_Name] dialog:

    1. Click the query pipeline on which you want to remove the condition.

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

  2. In the Edit a Query Pipeline: [QPL_Name] dialog:

    1. Under Condition, next to the condition, click the X icon.

    2. Click Save.

Rename a Query Pipeline

You cannot rename the default query pipeline.

  1. Access the Edit a Query Pipeline: [QPL_Name] dialog:

    1. Click the query pipeline that you want to rename.

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

  2. In the Edit a Query Pipeline: [QPL_Name] dialog:

    1. Change the query Pipeline name.

    2. Click Save.

Duplicate a Query Pipeline

The condition on the original pipeline is not included in the duplicated pipeline.

You can use the duplicate of a pipeline as a starting point for your A/B tests (see Adding and Managing A/B Tests).

  1. Click the query pipeline that you want to copy.

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

    A pipeline named Copy of [Original pipeline name] appears in the Pipelines page.

  3. Edit the duplicated pipeline to give it a more meaningful name (see Rename a query pipeline).

Delete a Query Pipeline

  1. Click the query pipeline that you want to remove.

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

  3. In the confirmation prompt that appears, click Yes.

  • You cannot delete the default query pipeline.

  • If you delete a query pipeline by inadvertence, contact Coveo Support to retrieve the query pipeline rules.

Manage Query Pipeline Components

  1. On the Query Pipelines page:

    You can access the default query pipeline by clicking the pipeline containing the Default tag in the Info column.

    Double-click the pipeline of which you want to edit the components.

    OR

    1. Select the desired pipeline row.

    2. In the Actions bar, clicking Edit components.

    Members with the privilege to view query pipelines (i.e., the View access level on the Query Pipelines domain) can click View components to review the pipeline component configurations in read-only mode (see Privilege Management and Query Pipelines Domain).

  2. On any [Query pipeline name] page:

Search Query Pipelines

On the Query Pipelines page, in the right section of the Action bar, type keywords in the Filter box. You can search exports by name, condition, and Info tag.

(When your organization contains more than 50 pipelines) On the Query Pipelines page, at the bottom-right of the table, click the left and right arrow icons, or a page number to navigate through pages.

Set the Number of Query Pipelines per Page

(When your organization contains more than 50 pipelines) On the Query Pipelines page, at the bottom-left of the page, select 25, 50, or 100.

By default, the table shows 50 pipelines per page.

Required Privileges

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

In this section, the content relative to Coveo ML models applies only for Coveo Cloud organizations created prior to April 23, 2019 that did not go through the Coveo ML migration process. Other organizations required a different set of privileges to manage models as they are created on the Models page (see Adding and Managing Coveo Machine Learning Models).

The ability to create query pipelines can be granted independently from the Edit all access level (see Understanding Privileges). You can therefore grant a group or an API key the View all or Custom access level for query pipelines and check the Can Create check box to allow users to create query pipelines (see Understanding the Custom Access Level).

Action Service - Privilege Required access level
View query pipeline

Analytics - Analytics data

Analytics - Dimensions

Machine learning - Models

Organization - Organization

Search - Query pipelines

View
Add, edit, and delete query pipelines

Analytics - Analytics data

Analytics - Dimensions

Organization - Organization

View

Machine learning - Models

Search - Query pipelines

Edit
Add, edit, delete, and test query pipelines

Analytics - Analytics data

Analytics - Dimensions

Organization - Organization

View

Machine learning - Models

Search - Query pipelines

Edit
Search - Execute queries Allowed
View models

Analytics - Analytics data

Analytics - Dimensions

Machine Learning - Models

Organization - Organization

Search - Query pipelines

View
Add, edit, and delete models

Analytics - Analytics data

Analytics - Dimensions

Organization - Organization

View

Machine learning - Models

Search - Query pipelines

Edit