Skip to content

Commit 4045e3b

Browse files
Add experimental warning to Search Relevance Workbench (#10174) (#10175)
1 parent 0318453 commit 4045e3b

File tree

8 files changed

+27
-3
lines changed

8 files changed

+27
-3
lines changed

_search-plugins/search-relevance/compare-query-sets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Comparing query sets
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
To compare the results of two different search configurations, you can run a pairwise experiment. To achieve this, you need two search configurations and a query set to use for the search configuration.
1417

1518

_search-plugins/search-relevance/comparing-search-results.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Comparing search results
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
Comparing search results, also called a _pairwise experiment_, in OpenSearch Dashboards allows you to compare results of multiple search configurations. Using this tool helps assess how results change when applying different search configurations to queries.
1417

1518
For example, you can see how results change when you apply one of the following query changes:

_search-plugins/search-relevance/evaluate-search-quality.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Evaluating search quality
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
Search Relevance Workbench can run pointwise experiments to evaluate search configuration quality using provided queries and relevance judgments.
1417

1518
For more information about creating a query set, see [Query sets]({{site.url}}{{site.baseurl}}/search-plugins/search-relevance/query-sets/).

_search-plugins/search-relevance/judgments.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Judgments
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
A judgment is a relevance rating assigned to a specific document in the context of a particular query. Multiple judgments are grouped together into judgment lists.
1417
Typically, judgments are categorized into two types---implicit and explicit:
1518

_search-plugins/search-relevance/optimize-hybrid-search.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Optimizing hybrid search
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
A key challenge of using hybrid search in OpenSearch is combining results from lexical and vector-based search effectively. OpenSearch provides different techniques and various parameters you can experiment with to find the best setup for your application. What works best, however, depends heavily on your data, user behavior, and application domain—there is no one-size-fits-all solution.
1417

1518
Search Relevance Workbench helps you systematically find the ideal set of parameters for your needs.

_search-plugins/search-relevance/query-sets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Query sets
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
A query set is a collection of queries. These queries are used in experiments for search relevance evaluation. Search Relevance Workbench offers different sampling techniques for creating query sets from real user data that adheres to the [User Behavior Insights (UBI)]({{site.url}}{{site.baseurl}}/search-plugins/ubi/schemas/) specification.
1417
Additionally, Search Relevance Workbench allows you to import a query set.
1518

_search-plugins/search-relevance/search-configurations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ has_toc: false
1010

1111
# Search configurations
1212

13+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
14+
{: .warning}
15+
1316
A search configuration defines the query pattern used to run experiments, specifying how queries should be constructed and executed.
1417

1518
## Creating search configurations

_search-plugins/search-relevance/using-search-relevance-workbench.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
---
22
layout: default
3-
title: Using Search Relevance Workbench
3+
title: Search Relevance Workbench
44
nav_order: 10
55
parent: Search relevance
66
has_children: true
77
has_toc: false
88
---
99

10+
# Search Relevance Workbench
11+
Introduced 3.1
12+
{: .label .label-purple }
1013

11-
12-
# Using Search Relevance Workbench
14+
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/17735).
15+
{: .warning}
1316

1417
In search applications, tuning relevance is a constant, iterative exercise intended to provide the right search results to your end users. The tooling in Search Relevance Workbench helps search relevance engineers and business users create the best search experience possible for application users. It does this without hiding internal information, enabling engineers to experiment and investigate details as necessary.
1518

0 commit comments

Comments
 (0)