Adds documentation about byField rerank processor #8593
Conversation
Signed-off-by: Brian Flores <[email protected]>
brianf-aws
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
v2.18.0
release-notes
Signed-off-by: Brian Flores <[email protected]>
There was a problem hiding this comment.
@kolchfa-aws @brianf-aws Please see my comments and changes and let me know if you have any questions. Thanks!
| {% include copy-curl.html %} | ||
|
|
||
| Which now yields the following. Observe that our documents are now sorted in a descending order based on the rating of each book, we kept the `previous_score` to help keep track of how we originally scored before reranking. | ||
|
|
There was a problem hiding this comment.
@kolchfa-aws I had to make a couple of assumptions in my rewrites here. Please ensure that they retain technical accuracy.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
| Configure a search pipeline with a [`rerank` processor]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/rerank-processor/) and specify the `by_field` rerank type. The pipeline sorts by the `reviews.stars` field (specified by a complete dot path to the field) and returns the original query scores for all documents along with their new scores: | ||
|
|
||
| ```json | ||
| PUT /_search/pipeline/rerank_byfield_pipeline |
There was a problem hiding this comment.
@brianf-aws Please verify this example. Thanks!
| "genre": { | ||
| "type": "keyword" | ||
| }, | ||
| "reviews": { |
There was a problem hiding this comment.
@brianf-aws: Does the reviews field need to be of an object type?
There was a problem hiding this comment.
if reviews points to a numerical score it can be used for example
{
reviews: 5
}
then the targetField would be just reviews. The target field depends on the knowledge of the user really and how well they know their documents
kolchfa-aws
added
6 - Done but waiting to merge
If you use postman or dev tools it wont work since there are qoutes in the index this had to be changed. Also it had to be made clear where the search pipeline would be applied in doing a search Signed-off-by: Brian Flores <[email protected]>
Signed-off-by: Brian Flores <[email protected]>
Description
Adds information about the byField rerank processor. which applies a second level rerank to a search response based on a provided user field
Issues Resolved
N/A
Version
2.18
Frontend features
N/A
Related PRs
opensearch-project/neural-search#932
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.