Add documentation for new reranking feature in 2.12 #6368

HenryL27 · 2024-02-07T23:05:14Z

document new reranking feature in 2.12

Description

Adds documentation for the new reranking feature

Issues Resolved

Closes #6359

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

document new reranking feature in 2.12 Signed-off-by: HenryL27 <hmlindeman@yahoo.com>

martin-gaievski

I'm not sure if there is one more PR for ml-commons, we may need to update documentation over there as well to mention cross-encoder model, somewhere in this section: https://opensearch.org/docs/latest/ml-commons-plugin/integrating-ml-models/#choosing-a-model

martin-gaievski · 2024-02-08T02:14:47Z

_search-plugins/reranking.md

+`ml_opensearch` rerank type parameters
+| field name | required? | description |
+| --- | --- | --- |
+| model_id | required | unique id of a TEXT_SIMILARITY model (deployed via ml-commons) |


can we add a link to ml-commons models documentation so new user can quickly get a context of what the model id is, e.g. https://opensearch.org/docs/latest/ml-commons-plugin/using-ml-models/

martin-gaievski · 2024-02-08T02:17:09Z

_search-plugins/reranking.md

@@ -0,0 +1,66 @@
+Creating a rerank pipeline:


please mention that this is a search pipeline, we can also add a link to corresponding section https://opensearch.org/docs/latest/search-plugins/search-pipelines/index/

martin-gaievski · 2024-02-08T02:18:28Z

_search-plugins/reranking.md

+`context` parameters
+| field name | dependent rerank types | description |
+| --- | --- | --- |
+document_fields | ml_opensearch | nonempty list of document fields to rerank over |


can we add an example of the doc with few fields and how to define field X in a list of document_fields

martin-gaievski · 2024-02-08T02:19:52Z

_search-plugins/reranking.md

+| query_text | the (natural language) text of the question you want to rerank over |
+| query_text_path | the json path to the text of the question you want to rerank over |
+
+when specifying `query_text_path`, use the fully specified path. For example, for the above query, you'd set `query_text_path = query.match.text_representation.query`.


I would add a full query example for query_text_path

martin-gaievski · 2024-02-08T02:22:52Z

_search-plugins/reranking.md

+| field name | description |
+| --- | --- |
+| query_text | the (natural language) text of the question you want to rerank over |
+| query_text_path | the json path to the text of the question you want to rerank over |


please add limits that has been added for params in scope of this PR

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws

Thank you, @HenryL27! I reorganized a bit and added the processor documentation in the processors section. Please take a look and see if anything needs to be changed. Thanks!

kolchfa-aws · 2024-02-13T02:51:14Z

@martin-gaievski Thanks a lot for reviewing! Yes, the applicable ML commons changes will be in PR #6357

HenryL27 · 2024-02-13T17:08:29Z

Technically I can't approve my own PR but LGTM! Thank you @kolchfa-aws

natebower

@kolchfa-aws @HenryL27 Please see my comments and changes and let me know if you have any questions. Thanks!

_search-plugins/search-pipelines/rerank-processor.md

natebower · 2024-02-13T17:32:34Z

_search-plugins/search-pipelines/rerank-processor.md

+
+Field name  | Description
+:--- | :---  
+`query_text` | The natural language text of the question using which you want to rerank the search results. Exactly one of `query_text` and `query_text_path` (not both) is required.


Can the last sentence be something like "Either query_text or query_text_path is required. These fields may not be used simultaneously"?

_search-plugins/search-pipelines/rerank-processor.md

natebower · 2024-02-13T17:33:34Z

_search-plugins/search-pipelines/rerank-processor.md

+Field name  | Description
+:--- | :---  
+`query_text` | The natural language text of the question using which you want to rerank the search results. Exactly one of `query_text` and `query_text_path` (not both) is required.
+`query_text_path` | The full JSON path to the text of the question using which you want to rerank the search results. Exactly one of `query_text` and `query_text_path` (not both) is required. The maximum number of characters in the path is `1000`.


Same comment re: the 2nd sentence.

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

natebower · 2024-02-13T17:40:02Z

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

+```
+{% include copy-curl.html %}
+
+Alternatively, you can provide the full path to the field containing context. For more information, see [Rerank processor example]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/rerank-processor/#example).


"containing the necessary context"?

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

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

…ct#6368) * Create reranking.md document new reranking feature in 2.12 Signed-off-by: HenryL27 <hmlindeman@yahoo.com> * Doc review and address comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: HenryL27 <hmlindeman@yahoo.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com>

Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Clarification of Customer Comment # 20230525 (opensearch-project#6374) * 20230525 clarificaton for customer comment on refernes to kibana Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> --------- Signed-off-by: leanne.laceybyrne@eliatra.com <leanne.laceybyrne@eliatra.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add searchbp metrics to Performance Analyzer (opensearch-project#5390) * added searchbp metrics Signed-off-by: Heather Halter <hdhalter@amazon.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update reference.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add documentation for new reranking feature in 2.12 (opensearch-project#6368) * Create reranking.md document new reranking feature in 2.12 Signed-off-by: HenryL27 <hmlindeman@yahoo.com> * Doc review and address comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: HenryL27 <hmlindeman@yahoo.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add Query Insights documentation (opensearch-project#6261) * Query Insights initial documentation Signed-off-by: Chenyang Ji <cyji@amazon.com> * Doc review Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * update endpoints and remove exporters Signed-off-by: Chenyang Ji <cyji@amazon.com> * Moved query insights to additional plugins section Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added installation instructions Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * merge conflicts and link fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Fix link Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Chenyang Ji <cyji@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Add Running a Workload (opensearch-project#6287) * Add Running a Workload draft Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update running-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _benchmark/user-guide/running-workloads.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Fix link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add additional missing link Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Add running workloads Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add numbered steps Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com>

Clarification of Customer Comment # 20230525 (#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

…ct#6368) * Create reranking.md document new reranking feature in 2.12 Signed-off-by: HenryL27 <hmlindeman@yahoo.com> * Doc review and address comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _search-plugins/search-pipelines/rerank-processor.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: HenryL27 <hmlindeman@yahoo.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>

Clarification of Customer Comment # 20230525 (opensearch-project#6374) * 20230525 clarificaton for customer comment on refernes to kibana * 20230525 clarificaton for customer comment on refernes to kibana - scentance clarification --------- Add searchbp metrics to Performance Analyzer (opensearch-project#5390) * added searchbp metrics * Update reference.md * Update reference.md * Apply suggestions from code review --------- Add documentation for new reranking feature in 2.12 (opensearch-project#6368) * Create reranking.md document new reranking feature in 2.12 * Doc review and address comments * Apply suggestions from code review * Update _search-plugins/search-pipelines/rerank-processor.md * Update _search-plugins/search-pipelines/rerank-processor.md --------- Add Query Insights documentation (opensearch-project#6261) * Query Insights initial documentation * Doc review * update endpoints and remove exporters * Moved query insights to additional plugins section * Added installation instructions * Apply suggestions from code review * editorial comments * Resolve merge conflicts * merge conflicts and link fix * Fix link --------- Add Running a Workload (opensearch-project#6287) * Add Running a Workload draft * Apply suggestions from code review * Update running-workloads.md * Update _benchmark/user-guide/running-workloads.md * Fix link * Add additional missing link * Add running workloads * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Add numbered steps --------- Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Create reranking.md

55dcdca

document new reranking feature in 2.12 Signed-off-by: HenryL27 <hmlindeman@yahoo.com>

HenryL27 requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower and dlvenable as code owners February 7, 2024 23:05

HenryL27 changed the title ~~[DOC] Documentation for new reranking feature in 2.12~~ Add documentation for new reranking feature in 2.12 Feb 7, 2024

hdhalter added release-notes PR: Include this PR in the automated release notes v2.12.0 labels Feb 8, 2024

hdhalter assigned kolchfa-aws Feb 8, 2024

hdhalter added the 4 - Doc review PR: Doc review in progress label Feb 8, 2024

martin-gaievski reviewed Feb 8, 2024

View reviewed changes

hdhalter added 3 - Tech review PR: Tech review in progress and removed 4 - Doc review PR: Doc review in progress labels Feb 8, 2024

Doc review and address comments

79adc1f

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

kolchfa-aws approved these changes Feb 13, 2024

View reviewed changes

natebower reviewed Feb 13, 2024

View reviewed changes

kolchfa-aws reviewed Feb 13, 2024

View reviewed changes

_search-plugins/search-relevance/reranking-search-results.md Outdated Show resolved Hide resolved

kolchfa-aws and others added 3 commits February 13, 2024 14:08

Apply suggestions from code review

12c3b39

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Update _search-plugins/search-pipelines/rerank-processor.md

ea86517

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Update _search-plugins/search-pipelines/rerank-processor.md

06ea407

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

kolchfa-aws merged commit 6d884b6 into opensearch-project:main Feb 13, 2024
2 of 3 checks passed

hdhalter added 3 - Done Issue is done/complete and removed 3 - Tech review PR: Tech review in progress labels Feb 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for new reranking feature in 2.12 #6368

Add documentation for new reranking feature in 2.12 #6368

HenryL27 commented Feb 7, 2024 •

edited by hdhalter

Loading

martin-gaievski left a comment

martin-gaievski Feb 8, 2024

martin-gaievski Feb 8, 2024

martin-gaievski Feb 8, 2024

martin-gaievski Feb 8, 2024

martin-gaievski Feb 8, 2024

kolchfa-aws left a comment

kolchfa-aws commented Feb 13, 2024

HenryL27 commented Feb 13, 2024

natebower left a comment

natebower Feb 13, 2024

natebower Feb 13, 2024

natebower Feb 13, 2024

kolchfa-aws Feb 13, 2024

Add documentation for new reranking feature in 2.12 #6368

Add documentation for new reranking feature in 2.12 #6368

Conversation

HenryL27 commented Feb 7, 2024 • edited by hdhalter Loading

Description

Issues Resolved

Checklist

martin-gaievski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws left a comment

Choose a reason for hiding this comment

kolchfa-aws commented Feb 13, 2024

HenryL27 commented Feb 13, 2024

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HenryL27 commented Feb 7, 2024 •

edited by hdhalter

Loading