Query Pipeline Management
- What Is a Query Pipeline
- Routing Mechanisms and Rules
- Deployment Overview
- Order of Execution of Query Pipeline Features
- Troubleshooting Query Pipeline Rules
- Coveo ML Model Association Management
- Thesaurus Rule Management
- Featured Results Rule Management
- Stop Words Rule Management
- Ranking Expressions Rule Management
- Ranking Weights Rule Management
- Triggers Rule Management
- Filters Rule Management
- Query Parameters Rule Management
- Query Pipeline Rule Management
- Coding Query Pipeline Rules
- Testing Changes
- Exporting and Importing Query Pipeline Elements
Troubleshooting Query Pipeline Rules
If one or more query pipeline rules are not behaving as you expect, you can find useful troubleshooting information in the execution report. This report contains query evaluation details such as which query pipeline features were applied and in what order, what the final query sent to the index was, and so on.
Access the Execution Report
Google Chrome is the browser used for this tutorial. Although you can access the execution report using any browser you like, the process may differ.
In the page where your search component is integrated, access the Network tab of the Google Chrome developer tools by either:
- Pressing the
Right-clicking anywhere in the page, selecting the Inspect option, and clicking Network tab.
- Pressing the
- Type a query in the search box, and then press the
Enterkey or click the search button.
- Enable the debug mode by either:
&debug=trueat the end of the current URL address.
Optionkey for Mac) and double-clicking on any search result box. At the top right of the panel you just opened, make sure the Enable query debug option is selected. You can then close this panel by pressing the
- Return to the developer tools panel you opened at Step 1.
In the Name column of the network request table, select the HTTP request which corresponds to the query you just submitted. This should be the latest
- Click the Preview tab. You should now see the query response body.
- Expand the
childrenproperty. You should now be able to visualize the whole path your query took before the results were returned to search interface.
In a new query pipeline named My Pipeline, you create the following Filters rule:
@source=="movie"to the advanced query expression (
In the same pipeline, you create the following Thesaurus rule:
The Lord of the Ringsin the current query by
The Fellowship of the Ringif the advanced query is
To test your changes in the query pipeline, you send this query to the search interface:
The Lord of the Rings. You realise that rule 2. was never applied.
To understand what went wrong with the query going through My Pipeline, you access the execution report, which gives you the following information:
As the items in the execution report children subsection appear in the actual order they were executed on the pipeline, you see that the Thesaurus rule executes before the Filters rule. Because of this, the advanced query (
aq) remains undefined until later in the execution when the Filters rule is executed, thus failing to satisfy your Thesaurus rule (see Order of Execution of Query Pipeline Features).