Exporting and Importing Query Pipeline Elements

When you have created query pipeline elements (query pipeline rules and Coveo Machine Learning (Coveo ML) models) and tested their effectiveness, you may want to reuse them. The import and export features allow members of the Administrators and Relevance Managers built-in groups to easily copy query pipeline elements and reuse them in another query pipeline or Coveo Cloud organization.

Coveo ML models can only be imported and exported within the same organization.

Access the “Import/Export” Panel

  1. On the Query Pipelines page, click the desired pipeline.

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

Export Query Pipeline Elements

  1. Access the “Import/Export” panel.

  2. In the Import/Export panel, select the Export tab.

  3. In the Export tab, select the pipeline component for which you want to export elements.

ExportPanel

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

Import Query Pipeline Elements

ImportPanel

  1. Access the “Import/Export” panel.

  2. In the Import/Export panel:

    1. When you want to keep the existing query pipeline configuration, export the desired elements.

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

    2. In the Import tab, click the drop-down menu, and then select the pipeline components for which you want to import pipeline elements.

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

  3. Click Choose File.

  4. Select the CSV file containing the query pipeline elements, and then click Open.

  5. Click Import.

Creating CSV Files for Importation

If you have a set of rules that you want to create for your organization, you can write them all in a CSV file which you can then import into your pipeline. This allows you to import multiple rules at once without having to manually create them using the [Query_Pipeline_Name] page.

You can use the following template in a spreadsheet to create your rules:

Csv

Definition

In this column, enter rules using the proper query pipeline language (QPL) syntax:

Condition

In this column, enter rules using the proper QPL syntax.

Description

In this column, you can enter a message to be displayed in the User Note column of the [Query_Pipeline_Name] page.

Feature

In this column, enter the Search API name of the query pipeline feature you are creating.

Once you have properly formatted your spreadsheet, ensure that you save the document in the CSV file format. You can then use this document to import your query pipeline elements.

Exporting and Importing Query Pipeline Rules Between Organizations

Coveo ML models from another organization cannot be imported.

You may have more than one Coveo Cloud organization: typically a staging organization (to test your changes without affecting users) and a production organization. Once you have tested a given query pipeline configuration change in your staging organization, you probably want to apply this change to your production organization. If you simply repeat your configuration changes from scratch in the production organization, there is a risk that you may forget a parameter. Instead, you should use the export and import features to easily transfer pipeline elements from one organization to another

Illustration_OrgA_to_B

  1. Access the Coveo Cloud organization from which you want to import query pipeline rules, and then access the “Import/Export” panel.

  2. Export the desired query pipeline rules.

    Note where the CSV is saved. You will need to retrieve it to import the rules in the other organization.

  3. Switch to the organization in which you want to import the pipeline rules.

  4. Access the “Import/Export” panel.

  5. Import the desired query pipeline rules.

Recommended Articles