Skip to content
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

Creates the Kendra plugin section in Compare Search Results #2060

Merged
merged 2 commits into from
Jan 9, 2023

Conversation

kolchfa-aws
Copy link
Collaborator

@kolchfa-aws kolchfa-aws commented Nov 28, 2022

Creates the Kendra plugin section in Compare Search Results.

This is targeted to be released when the Kendra plugin is released (currently, scheduled for 1/9/23. The previous PR was #2012 and has been already reviewed.

Fixes #2206

Checklist

  • [ x] 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.

@kolchfa-aws kolchfa-aws self-assigned this Nov 28, 2022
@kolchfa-aws kolchfa-aws added the 6 - Done but waiting to merge PR: The work is done and ready to merge label Nov 28, 2022
@Naarcha-AWS Naarcha-AWS mentioned this pull request Jan 3, 2023
4 tasks
Copy link
Contributor

@macohen macohen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check links after the external docs are released. Thanks!

@kolchfa-aws kolchfa-aws marked this pull request as ready for review January 9, 2023 15:45
@kolchfa-aws kolchfa-aws requested a review from a team as a code owner January 9, 2023 15:45
@kolchfa-aws kolchfa-aws added 4 - Doc review PR: Doc review in progress and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Jan 9, 2023
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of small changes, but otherwise looks good.

_search-plugins/search-relevance/index.md Show resolved Hide resolved
_search-plugins/search-relevance/index.md Outdated Show resolved Hide resolved
@carolxob carolxob self-requested a review January 9, 2023 16:01
Copy link
Contributor

@carolxob carolxob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with Nate's comments.

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

## Comparing OpenSearch search results with re-ranked results

One use case of Compare Search Results is to compare raw OpenSearch results with the same results processed by a re-ranking application. An example of such a re-ranker is **Kendra Intelligent Ranking for OpenSearch**, contributed by the Amazon Kendra team. This plugin takes search results from OpenSearch and applies Kendra’s semantic relevance rankings calculated using vector embeddings and other semantic search techniques. For many applications, this gives better result rankings.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
One use case of Compare Search Results is to compare raw OpenSearch results with the same results processed by a re-ranking application. An example of such a re-ranker is **Kendra Intelligent Ranking for OpenSearch**, contributed by the Amazon Kendra team. This plugin takes search results from OpenSearch and applies Kendra’s semantic relevance rankings calculated using vector embeddings and other semantic search techniques. For many applications, this gives better result rankings.
One use case for Compare Search Results is to compare raw OpenSearch results with the same results processed by a re-ranking application. An example of such a re-ranker is **Kendra Intelligent Ranking**, contributed by the Amazon Kendra team. This plugin takes search results from OpenSearch and applies Amazon Kendra’s semantic relevance rankings calculated using vector embeddings and other semantic search techniques. For many applications, this provides better result rankings.

To try Kendra Intelligent Ranking, you must first set up the Amazon Kendra service. To get started, see [Amazon Kendra](https://aws.amazon.com/kendra/). For detailed information, including plugin setup instructions, see [Intelligently ranking OpenSearch (self managed) results using Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/opensearch-rerank.html).

Once you've set up Kendra Intelligent Ranking, enter a query in **Query 1** and the same query using the Kendra Intelligent Ranking service for re-ranking in **Query 2**. Then compare search results from OpenSearch and Amazon Kendra.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once you've set up Kendra Intelligent Ranking, enter a query in **Query 1** and the same query using the Kendra Intelligent Ranking service for re-ranking in **Query 2**. Then compare search results from OpenSearch and Amazon Kendra.
Once you've set up Kendra Intelligent Ranking, enter a query in **Query 1** and enter the same query using the Kendra Intelligent Ranking service for re-ranking in **Query 2**. Then compare the search results from OpenSearch and Amazon Kendra.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this read "...and enter the same query using Kendra Intelligent Ranking in Query 2."?

### Example

The following example searches for the text "snacking nuts" in the `abo` index. The documents in the index hold snack descriptions in the `bullet_point` array.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following example searches for the text "snacking nuts" in the `abo` index. The documents in the index hold snack descriptions in the `bullet_point` array.
The following example searches for the text "snacking nuts" in the `abo` index. The documents in the index contain snack descriptions in the `bullet_point` array.

```

In the preceding query, `body_field` refers to the body field of the documents in the index, on which Kendra Intelligent Ranking ranks the results. The `body_field` is required, while the `title_field` is optional.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this read "...the documents in the index, which Kendra Intelligent Ranking uses to rank the results."?

Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws kolchfa-aws added backport 2.4 PR: Backport label for 2.4 and removed 4 - Doc review PR: Doc review in progress labels Jan 9, 2023
@kolchfa-aws kolchfa-aws merged commit f353f86 into main Jan 9, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 9, 2023
* Creates the Kendra plugin section in Compare Search Results

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
(cherry picked from commit f353f86)
kolchfa-aws added a commit that referenced this pull request Jan 9, 2023
…2356)

* Creates the Kendra plugin section in Compare Search Results

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
(cherry picked from commit f353f86)

Co-authored-by: kolchfa-aws <[email protected]>
vagimeli pushed a commit that referenced this pull request Jan 10, 2023
* Creates the Kendra plugin section in Compare Search Results

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
@Naarcha-AWS Naarcha-AWS deleted the kendra-new branch March 28, 2024 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.4 PR: Backport label for 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Reranker plugin
5 participants