Manage query pipelines

This is for:

Developer System Administrator

You can use the Query Pipelines (platform-ca | platform-eu | platform-au) page in the Administration Console to manage components such as rules and Coveo Machine Learning (Coveo ML) models in a Coveo organization (see What’s a query pipeline?). This allows you to optimize the relevance of your search results and the overall search experience. Every organization has a default query pipeline that’s automatically created when an organization is first created. However, you can create additional query pipelines if you have multiple search interfaces with distinct users and purposes, and you want to apply different rules or models to each interface.

Create a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click Add Pipeline.

  2. In the Add a Query Pipeline panel that opens, select the Configuration tab.

  3. Enter a Pipeline name.

    Note

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

  4. Enter a Description for the query pipeline to help Administration Console members understand its purpose.

  5. Select a Use case to categorize your query pipeline.

  6. Under Condition, select or create an appropriate query pipeline condition to apply.

  7. In the Interface URL section, you can optionally define the URLs of the search interfaces that use this query pipeline.

  1. In the Access tab, specify whether each group (and API key, if applicable) in your Coveo organization can view or edit the current pipeline.

    For example, when creating a new pipeline, you could decide that members of Group A can edit its configuration, while Group B can only view it.

    For more information, see Custom access level.

    Note

    To modify access to a query pipeline, you need additional privileges. See the required privileges for managing member access and API keys.

  2. Click Add Pipeline.

Tip

If you have the Enterprise edition, group this query pipeline and your other implementation resources together in a project. See Manage projects.

Manage query pipelines

On the Query Pipelines (platform-ca | platform-eu | platform-au) page, you can:

Test a query pipeline in the Content Browser

Click the query pipeline that you want to test, and then click More > Open in Content Browser in the Action bar.

On the Content Browser (platform-ca | platform-eu | platform-au) page, you can perform queries to validate the behavior of this specific pipeline.

Export and import query pipeline rules and/or models

Once you’ve created rules and models, you may want to reuse them in other query pipelines. Exporting and importing query pipeline elements helps you streamline the migration of rules and models from one pipeline to another. For more information, see Export and import query pipeline elements.

Set a query pipeline as the default

Click the query pipeline that you want to set as the default, and then click More > Set as default in the Action bar.

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

The default query pipeline is used when no pipeline condition matches the query (see Query pipeline routing mechanisms and rules).

Note

Only one pipeline can be configured as the default pipeline. You can’t delete the default pipeline without first setting another pipeline as the default.
Important

Since the default query pipeline is used when no other pipeline matches the query, it’s important to make sure that no condition is set on the default pipeline. This way, the default pipeline applies to all queries when needed.

Edit the condition on a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the desired query pipeline, and then click Edit components in the Action bar.

  2. On the page that opens, select the Overview tab.

  3. Under Condition, click x next to the condition to remove the current condition.

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

  5. Click Save.

Rename a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the desired query pipeline, and then click Edit components in the Action bar.

  2. On the page that opens, select the Overview tab.

  3. Under Pipeline name, you can change the query pipeline name.

  4. Click Save.

Note

If you want to rename a query pipeline used in production, you should do so by creating an A/B test. 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’ll need to update it and test that everything works as desired.

Duplicate a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that you want to copy, and then click Duplicate in the Action bar.

    On the Query Pipelines page, a copy of the pipeline is instantly created and appears at the bottom of the page.

  2. Edit the duplicated pipeline to give it a more meaningful name.

Notes

  • The conditions on the original pipeline aren’t included in the duplicated pipeline.

  • You can use the duplicate of a pipeline as a starting point for your A/B tests.

Modify access to a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that you want to modify, and then click More > Edit access in the Action bar.

  2. On the page that opens, click dots in the upper-right corner, and then click Manage access.

  3. In the Manage access panel that appears, you can modify access levels for groups and API keys.

Note

To modify access to the query pipeline, you need additional privileges. See the required privileges for managing member access and API keys.

Delete a query pipeline

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline that you want to remove, and then click Delete in the Action bar.

  2. In the confirmation prompt that appears, click Delete.

Notes

  • You can’t delete the default query pipeline.

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

Manage query pipeline components

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the desired query pipeline, and then click Edit components in the Action bar.

  2. On any pipeline page, you can add and manage the following query pipeline components:

Deploy a query pipeline

When you want to deploy a query pipeline:

  1. Choose a query pipeline routing mechanism. We recommend that you use condition-based routing.

  2. In your Coveo organization, create a query pipeline with specific rules for the desired search interface.

    Tip
    Leading practice

    You can duplicate an existing query pipeline and make changes instead of creating a new one.

  3. Add a condition for the pipeline to be used when a query comes from your search interface.

    Example

    Search Hub is External Search.

  4. Validate that the search interface uses the new query pipeline. For example, the new pipeline has a stop word rule that isn’t in any other pipeline. Therefore, you test the query pipeline in the Content Browser by performing a query that would be affected by the stop word rule.

Required privileges

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 pipelines

Organization - Organization
Search - Query pipelines

View

Add, edit, and delete query pipelines

Organization - Organization

View

Search - Query pipelines

Edit
Note

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 checkbox to allow users to create query pipelines.

The privileges required to view or edit query pipeline rules differ depending on the type of rule you want to manage.

Refer to the following links to learn more about the privileges required to view or edit a given type of rule: