Updated ES specification to support simplified retrievers#4912
Merged
mridula-s109 merged 1 commit intomainfrom Jul 14, 2025
Merged
Updated ES specification to support simplified retrievers#4912mridula-s109 merged 1 commit intomainfrom
mridula-s109 merged 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds optional query parameters to the ES specification retrievers, enabling simplified text-based searches directly in the retriever definitions.
- Introduces
query,fields, andnormalizertoLinearRetriever - Introduces
queryandfieldstoRRFRetriever - Aligns the specification with recent Kibana Dev Console changes for simplified retrievers
Comments suppressed due to low confidence (6)
specification/_types/Retriever.ts:72
- Add a JSDoc comment for
queryto explain its purpose, e.g.:/** A query string for a text-based search. */
query?: string
specification/_types/Retriever.ts:73
- Add a JSDoc comment for
fieldsto describe which document fields are searched, e.g.:/** The fields to run the query against. */
fields?: string[]
specification/_types/Retriever.ts:74
- Add a JSDoc comment for
normalizer, e.g.:/** The normalizer to use for scoring. */, and verify thatScoreNormalizeris imported or defined above.
normalizer?: ScoreNormalizer
specification/_types/Retriever.ts:142
- Add a JSDoc comment for
queryinRRFRetriever, e.g.:/** A query string for a text-based search. */
query?: string
specification/_types/Retriever.ts:143
- Add a JSDoc comment for
fieldsinRRFRetriever, e.g.:/** The fields to run the query against. */
fields?: string[]
specification/_types/Retriever.ts:72
- No tests appear to cover the new
query,fields, andnormalizerproperties; please add validation tests to ensure they are correctly serialized and validated in the API schema.
query?: string
Contributor
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
github-actions bot
pushed a commit
that referenced
this pull request
Jul 14, 2025
(cherry picked from commit 177af77)
github-actions bot
pushed a commit
that referenced
this pull request
Jul 14, 2025
(cherry picked from commit 177af77)
mridula-s109
added a commit
that referenced
this pull request
Jul 15, 2025
mridula-s109
added a commit
that referenced
this pull request
Jul 15, 2025
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.