Add ext object to search response #4959
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
requested review from
cwillum,
hdhalter,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
|
@austintlee Could you review this PR for technical accuracy please? |
3 tasks
austintlee
reviewed
Sep 5, 2023
_api-reference/search.md
Outdated
|
|
||
| ## The `ext` object | ||
|
|
||
| Starting with OpenSearch 2.10, plugin authors can add an `ext` object to the search response. The purpose of the `ext` object is to contain plugin-specific response fields. For example, in conversational search, the result of Retrieval Augmented Generation (RAG) is a single "hit" (answer). Plugin authors can include this answer in the search response as part of the `ext` object so it is separate from the search hits. In the following example response, the RAG result is in the `ext.generative_qa.answer` field: |
There was a problem hiding this comment.
Can you change 'generative_qa' to 'retrieval_augmented_generation'. Both here and in the sample below.
austintlee
suggested changes
Sep 5, 2023
_api-reference/search.md
Outdated
| ], | ||
| }, // end of hits | ||
| "ext": { | ||
| "generative_qa": { // a search response processor |
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
|
Done |
kolchfa-aws
added
the
release-notes
|
@austintlee I've changed both instances. Could you review again please? |
|
Looks good! |
vagimeli
approved these changes
Sep 6, 2023
|
@austintlee Thanks! Could you approve then? |
austintlee
approved these changes
Sep 6, 2023
natebower
reviewed
Sep 7, 2023
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
kolchfa-aws
added
the
6 - Done but waiting to merge
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
* Add ext object to search response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update search.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _api-reference/search.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli
pushed a commit
that referenced
this pull request
Dec 21, 2023
* Add ext object to search response Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update search.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update _api-reference/search.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4877
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.