Fusion UI Relevancy Workbench Tool

The Relevancy Workbench (RWB) provides a sandbox for trying out different query pipelines. It provides a display that allows users to perform a side-by-side comparison of query pipelines which tracks changes in search results according to changes in criteria. During application development, this tool can be used for query tuning by running a series of common queries to judge the goodness and consistency of the results. This tool can also be used to troubleshoot problems that arise in production, as the contents of the collection change over time.

To access this tool, you can either click on the icon for the Fusion UI Relevancy Workbench Tool, shown above, which is found on the main Fusion UI page, (the page displayed immediately after initial login and/or is reached by clicking on the Lucidworks Fusion label in the very top left-hand corner of the UI), or you can enter the URL http://http://host:port/relevancy-workbench, where host is the servername and port is the port that the Fusion UI is running on.

This tool has three components, listed across the top as "Pipelines", "Queries and Documents", and "Settings".

  • Pipeline panel. This panel is used to tune the general behavior of query pipelines, via a side-by-side comparison of the documents returned for a given query. The left-hand-side pipeline is treated as the starting point for query tuning. Differences between the left-hand-side pipeline and the right-hand-side pipeline are described as "added", "removed", "demoted", and "promoted" so that "added" means that a document is present in the search results for the pipeline on the right but not on the left, and vice versa for "removed" and "demoted" means that a document on the left has a higher score than a document on the right, and vice versa for "promoted".

  • Queries and Documents panel. This panel is used to tune the search results for specific documents returned by a query.

  • Settings panel. This panel is used to specify a collection and a query pipeline used for search over that collection.

Clicking on the names of these components toggles the display between these panels.

The first time you run this tool on a Fusion installation, it opens the Settings panel. You must specify a collection and a query pipeline. These choices are stored locally. In subsequent sessions, the Relevancy Workbench opens in the Pipelines panel. Once a collection and query pipeline have been chosen, you can go to the Pipelines panel to tune queries, or to the Queries and Documents panel.