Adding and Managing Query Pipelines

You can use the Query Pipelines page in the Administration Console navigation menu to manage the thesaurus, featured results, stop words, ranking expressions, ranking weights, and triggers rules as well as Coveo Machine Learning (Coveo ML) models of your Coveo Cloud organization (see What Is a Query Pipeline). This allows you to optimize search results relevance and search experience in general.

The components of the query pipeline (machine learning, thesaurus, featured results, stop words, ranking expressions, ranking weights, and triggers) are all accessible and manageable from a [Query pipeline name] page.

Access the “Query Pipelines” Page

  1. If not already done, log in to your Coveo Cloud Organization with an Admin or Relevance Analyst user role account.

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

Create a Query Pipeline

  1. Access the Query Pipelines page (see Access the “Query Pipelines” Page).

  2. On the Query Pipelines page, click Add pipeline.

  3. In the Add a Pipeline dialog:

    1. In the first input, enter a Name for the query pipeline.

      This name appears as the title of your pipeline page and is used if the query pipeline is hardcoded in a Coveo JavaScript SearchInterface component (see SearchInterface Component).

    2. In the User note input, 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.

  4. Click Add Pipeline.

  5. Back on the Query Pipelines page, on the line of the newly created pipeline, click Actions Source-Actions-Icon, and then select Edit condition to set the condition determining when queries use this pipeline (see Query Pipeline Routing Mechanisms and Rules).

  6. In the Select a Condition dialog, select an appropriate existing condition, and then click Save.

    Be aware that the condition is now effective on the query pipeline.

    When the desired condition doesn’t yet exist, click Add Condition to create a condition (see Create a Condition) or click Manage Conditions to go to the Conditions page where you can edit an existing condition (see Modify a Condition), and then come back to the Query Pipelines page to select the modified condition.

Search Query Pipelines

  1. If not already done, log in to your Coveo Cloud organization with an Admin or Analytics Manager user role account.

  2. In the navigation bar on the left, under Search Optimization, select Query Pipelines.

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

Manage Query Pipelines

  1. Access the Query Pipelines page (see Access the “Query Pipelines” Page).

  2. On the Query Pipelines page:

    • Test a pipeline in the Content Browser

      Click Actions Source-Actions-Icon at the end of the query pipeline row that you want to test, and then select Open in Content Browser.

      In the Content Browser page that appears in a new browser tab, you can perform queries to validate the behavior of this specific pipeline.

    • Import query pipeline rules and/or models

      1. Click Actions Source-Actions-Icon at the end of a query pipeline row, and then select Import/Export.

      2. 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 (Tune relevance, Suggest queries, and Give recommendations) and/or rules:

          • All

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

          • Featured results

          • Filters

          • Give recommendations

          • Query parameters

          • Ranking expressions

          • Ranking weights

          • Stop words

          • Suggest queries

          • Thesaurus

          • Triggers

          • Tune relevance

      3. Click Choose File.

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

      5. Click Import.

    • Export query pipeline rules and/or models

      1. Click Actions Source-Actions-Icon at the end of a query pipeline row, and then select Import/Export.

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

      3. In the Export tab, select the pipeline component(s) rules or models you want to export (All, Featured results, Filters, Give recommendations, Query parameters, Ranking expressions, Ranking weights, Stop words, Suggest queries, Thesaurus, Triggers, or Tune relevance).

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

    • Set a query pipeline as the default one

      Click Actions Source-Actions-Icon at the end of the query pipeline row that you want to make the default pipeline, and then select Set as default.

      The Admin-QPLDefaultTag tag appears in the Info column for this pipeline.

      The Admin-QPLDefaultTag 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 Admin-QPLDefaultTag tag. You can’t remove the default pipeline without first setting another pipeline as the default pipeline.

    • Rename a query pipeline

      You can’t rename the Admin-QPLDefaultTag query pipeline.

      1. Click Actions Source-Actions-Icon at the end of a query pipeline row, and then select Edit pipeline.

      2. In the Edit a Query Pipeline dialog that appears:

        1. Change the query pipeline Name.

        2. Click Save.

    • Duplicate a query pipeline

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

      1. Click Actions Source-Actions-Icon at the end of a query pipeline row, and then select Duplicate.

        A pipeline named Copy of <ORIGINAL_PIPELINE_NAME> appears on the Query Pipelines page.

      2. Edit the duplicated pipeline to rename it to a meaningful name (see Rename a query pipeline).

    • Swap a query pipeline

      Swapping query pipelines is only useful in the context of A/B tests since it changes the specified pipeline in your search page code without having to involve developers.

      1. At the end of a query pipeline row, click Actions Source-Actions-Icon, and then select Swap a pipeline.

      2. In the Swap a Query Pipeline dialog that appears, select the pipeline that you want to exchange the current pipeline with.

        The current pipeline is now used in the search page the pipeline you just select was specified.

        In the context of an A/B test, you swap pipeline A with pipeline B because the latter has improved the Average Click Rank of your search results.

    • Delete a query pipeline

      1. Click Remove Grey-Garbage-Icon at the end of the query pipeline row.

        OR

        Select the query pipeline row check box, and then click Remove.

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

      • You can’t delete the Admin-QPLDefaultTag query pipeline.

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

  3. Access a specific pipeline page by clicking the pipeline in the Name column.

    You can access the default query pipeline by clicking the pipeline containing the Admin-QPLDefaultTag tag in the Info column.

    Admin-Pipelinesd

  4. On any <QUERY_PIPELINE_NAME> page:

Who Can Perform the Page Actions

The required roles are:

  • Administrator

    OR

  • Relevance Analyst

Recommended Articles