Adding and Managing Query Pipelines

Members of the Administrators and Relevance Managers built-in groups can use the Query Pipelines page in the Administration Console navigation menu to manage the thesaurus, result ranking, featured result, stop word, ranking expression, ranking weight, and trigger rules as well as Coveo Machine Learning (Coveo ML) models of a Coveo organization (see What’s a Query Pipeline?). This allows you to optimize search results relevance and search experience in general.

If you’re currently migrating your Coveo 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 doesn’t apply to Coveo Machine Learning (Coveo ML) models.

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

If you leverage a feature that’s only available in a Coveo organization, this feature won’t be visible in your V1 organization.

Create a Query Pipeline

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

  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’re looking for to refine the list of displayed conditions.

        OR

      • When the desired condition doesn’t 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’s 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 aren’t 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.

  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 and Import Query Pipeline Rules and/or Models

See Exporting and Importing Query Pipeline Elements.

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 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’s always one and only one pipeline configured as the default pipeline identified with the Default tag. You can’t remove the default pipeline without first setting another pipeline as the default pipeline.

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

Edit the Condition on a Query Pipeline

  1. Access the Edit a Query Pipeline 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 dialog, under Condition, click X next to the condition to remove the current condition.

  3. Optionally, select or create a condition to replace the one you removed.

  4. Click Save.

Rename a Query Pipeline

  1. Access the Edit a Query Pipeline 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 dialog:

    1. Change the query Pipeline name.

    2. Click Save.

If you want to rename a query pipeline used in production, you should do so by following the pipeline testing procedure. That’s because you need to update all references to the old query pipeline name, lest you break your search solution. For example, if you set the pipeline name in search tokens, you will need to update it and test that everything works as desired.

Duplicate a Query Pipeline

The condition on the original pipeline isn’t 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.

    On the Pipelines page, a copy of the pipeline is created.

  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 can’t 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.

    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 pipeline page, you can add and manage query pipeline:

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).

The ability to create query pipelines can be granted independently from the Edit all access level (see Can Create Ability Dependence). 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.

Action Service - Domain Required access level
View query pipelines

Analytics - Analytics data

Analytics - Dimensions

Search - Query pipelines

View
Add, edit, and delete query pipelines

Analytics - Analytics data

Analytics - Dimensions

View

Search - Query pipelines

Edit
Add, edit, delete, and test query pipelines

Analytics - Analytics data

Analytics - Dimensions

View

Search - Query pipelines

Edit
Search - Execute queries Allowed
Recommended Articles