Code query pipeline rules

This is for:

Developer System Administrator
In this article

Coveo organization members with developer skills can use the Query pipeline language (QPL) syntax to create more flexible query pipeline rules.

Note

You can create Coveo Machine Learning (Coveo ML) models using JSON configurations.

To code query pipeline language rules

  1. On the Query Pipelines (platform-ca | platform-eu | platform-au) page, click the query pipeline for which you want to code rules, and then click Edit components in the Action bar.

  2. On the selected pipeline page, select the tab for the type of rule that you want to code.

  3. On the selected component subpage, click dots, and then click Add rule with code.

  4. In the Add a Rule With Code dialog:

    Admin-CreateRuleCode3

    1. Enter a rule respecting the query pipeline language syntax.

    2. Click Add Rule.

      Note

      If you try to use this interface to extend the Coveo query pipeline behavior (for example, by entering JavaScript code), you’ll receive an error message:

      The definition of the statement is syntactically invalid.

  5. You can perform other actions on your rule (see Manage query pipeline rules and rule conditions From Tabs).

  6. Validate that your new rule performs as desired (see Manage A/B tests or Testing Coveo Machine Learning models).

Required privileges

By default, members of the Administrators and Relevance Managers built-in groups can view and edit elements of the Query Pipelines (platform-ca | platform-eu | platform-au) page.

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

Action Service - Domain Required access level

View query pipeline rules

  • Organization - Organization

  • Search - Query pipelines

View

Add and edit query pipeline rules with code

Organization - Organization

View

Search - Query pipelines

Edit