Updated ES specification to support simplified retrievers#4911
Closed
mridula-s109 wants to merge 1 commit intoelastic:mainfrom
Closed
Updated ES specification to support simplified retrievers#4911mridula-s109 wants to merge 1 commit intoelastic:mainfrom
mridula-s109 wants to merge 1 commit intoelastic:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR extends the Elasticsearch specification types to allow simple query-based retriever configurations.
- Adds optional
query,fields, andnormalizerparameters toLinearRetriever - Adds optional
queryandfieldsparameters toRRFRetriever
Comments suppressed due to low confidence (6)
specification/_types/Retriever.ts:72
- Add a JSDoc comment above
queryto describe its purpose and expected format, matching the style of existing field comments.
query?: string
specification/_types/Retriever.ts:73
- Add a JSDoc comment above
fieldsto explain this array’s intended use and any constraints on field names.
fields?: string[]
specification/_types/Retriever.ts:74
- Add a JSDoc comment above
normalizerto clarify which normalizer options are supported and how scoring is affected.
normalizer?: ScoreNormalizer
specification/_types/Retriever.ts:142
- Add a JSDoc comment above this
queryfield inRRFRetriever, describing its role in the retrieval process.
query?: string
specification/_types/Retriever.ts:143
- Add a JSDoc comment above this
fieldsarray inRRFRetrieverto explain how field selection affects result sets.
fields?: string[]
specification/_types/Retriever.ts:72
- Add or update unit tests (and integration tests if applicable) to cover the new
query,fields, andnormalizeroptions on bothLinearRetrieverandRRFRetriever.
query?: string
Mikep86
reviewed
Jul 14, 2025
Contributor
Mikep86
left a comment
There was a problem hiding this comment.
Looks like we need to use a branch in the elastic/elasticsearch-specification repo to get CI to pass
Contributor
Author
Thanks for bringing it to my notice. I thought there was a way around it, as there isnt have created a new PR from the main repo branch - #4912. |
This file contains hidden or 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
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.
This PR introduces the following optional fields to specification/_types/Retriever.ts:
query?: string: A query string for a text-based search.fields?: string[]: The fields to run the query against.normalizer?: ScoreNormalizer: The normalizer to use for scoring.query?: string: A query string for a text-based search.fields?: string[]: The fields to run the query against.These additions allow users to specify a simple query string directly within the retriever, aligning it with recent changes made in the Kibana Dev Console (SEARCH-1091).
Validation
The specification was validated against the
searchAPI usingmake validate api=search branch=main.