-
Couldn't load subscription status.
- Fork 621
update Search Relevance Workbench docs for 3.2 #10514
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
9777aaf
5da6a8b
9ec7dc1
ef8c362
cdfd44f
e022da5
615cd35
b9fd139
4c3f441
bfa9d52
5adee8e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| layout: default | ||
| title: Exploring search evaluation results | ||
| nav_order: 65 | ||
| parent: Search Relevance Workbench | ||
| grand_parent: Search relevance | ||
| has_children: false | ||
| --- | ||
|
|
||
| # Exploring search evaluation results | ||
| Introduced 3.2 | ||
| {: .label .label-purple } | ||
|
|
||
| In addition to retrieving the experiment results using the API, you can explore the results visually. The Search Relevance Workbench comes with dashboards that you can install to review search evaluation and hybrid search optimization experiment results. | ||
|
|
||
| ## Installing the dashboards | ||
|
|
||
| You can install the dashboards in one of the following ways: | ||
|
|
||
| * In the **Actions** column, select a visualization icon in the experiment overview. | ||
|
|
||
| * Select the **Install Dashboards** button in the upper-right corner of the experiment overview. | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/search-relevance-workbench/experiment_overview_dashboard_installation_options.png" alt="Experiment overview of the Search Relevance Workbench including dashboard installation options"/>{: .img-fluid } | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please minimize the number of screenshots. Modal screenshots are not necessary since they are self-explanatory. All screenshots must have an intro sentence ending with "as shown in the following image". |
||
|
|
||
| The modal offers to install the dashboards for the user. | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/search-relevance-workbench/install_dashboards_modal.png" alt="Modal to install dashboards"/>{: .img-fluid } | ||
|
|
||
| ## Using the dashboards | ||
|
|
||
| Once you install the dashboards, in the **Actions** column, select the visualization icon in the experiment overview. This opens the experiment result dashboard. The view presented depends on the type of experiment you chose: | ||
|
|
||
| * The search evaluation dashboard focuses on the individual query level and provides insights about well-performing queries and queries with open relevance potential. | ||
|
|
||
| * The hybrid search dashboard provides an overview of how the different hybrid search parameter configurations performed and lets you identify candidate queries for further exploration and experimentation. | ||
|
|
||
| ### Search evaluation dashboard | ||
|
|
||
| The search evaluation dashboard, shown in the following image, aggregates performance metrics across all queries in your selected experiment. Use the search evaluation dashboard to get a high-level view of overall experiment performance and identify the queries that need attention. | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/search-relevance-workbench/search_evaulation_dashboard.png" alt="Search evaluation dashboard with visualizations"/>{: .img-fluid } | ||
|
|
||
| The **Deep Dive Summary** panel shows the aggregate metrics for NDCG, MAP, precision, and coverage (see [Evaluating search quality]({{site.url}}{{site.baseurl}}/search-plugins/search-relevance/search-configurations/)). | ||
|
|
||
| The **Deep Dive Query Scores** pane shows individual query performance ranked by NDCG score (highest to lowest). Use this pane to identify your best- and worst-performing queries. | ||
|
|
||
| The **Deep Dive Score Densities** pane shows how metric values are distributed across your query set. Use this pane to understand whether poor performance is widespread or concentrated in specific queries. The x-axis shows metric values, while the y-axis shows how frequently those values occur. | ||
|
|
||
| The **Deep Dive Score Scatter Plot** pane shows an interactive view of the preceding distribution data, with each query shown as a separate point. Use this pane to investigate specific queries at performance extremes. Points are scattered vertically to prevent overlap while maintaining the same x-axis metric values as the preceding distribution view. | ||
|
|
||
| ### Hybrid search evaluation dashboard | ||
|
|
||
| Use the hybrid search evaluation dashboard, shown in the following image, to compare experiment variants and identify the optimal parameter configurations for your hybrid experiment. | ||
|
|
||
| <img src="{{site.url}}{{site.baseurl}}/images/search-relevance-workbench/hybrid_search_optimizer_dashboard.png" alt="Hybrid search optimization evaluation dashboard with visualizations"/>{: .img-fluid } | ||
|
|
||
| The **Variant Performance Chart** shows your experiment variants arranged visually from best to worst performing (left to right, by decreasing NDCG). Use this chart to quickly identify your top-performing queries and view performance patterns across different parameter combinations at a glance. | ||
|
|
||
| The **Variant Performance** pane shows the same variant data in a sortable table format with all metrics visible. Use this pane to compare specific metric values across variants and customize your analysis by sorting on different performance measures. To sort by a column, select the column header. | ||
|
|
||
|
|
||
| ### Customizing the dashboards | ||
|
|
||
| The dashboards are installed as saved objects. After installing them, you can edit the dashboards or clone and customize them to your specific requirements. | ||
|
|
||
| To learn how to customize the source files, see [Updating the default dashboards](https://github.com/opensearch-project/dashboards-search-relevance/blob/main/DEVELOPER_GUIDE.md#updating-default-dashboards). | ||
|
|
||
| ### Resetting dashboards | ||
|
|
||
| To reset the dashboards, select the **Install Dashboards** button in the upper-right corner of the experiment overview. This will reinstall the dashboards. | ||
|
|
||
|
|
||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.