Skip to content

[Backport 9.0] Update requirement types for retriever fields #4682

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 25, 2025
Merged

[Backport 9.0] Update requirement types for retriever fields #4682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 5 additions & 7 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions specification/_types/Retriever.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ export class RescorerRetriever extends RetrieverBase {
export class LinearRetriever extends RetrieverBase {
/** Inner retrievers. */
retrievers?: InnerRetriever[]
rank_window_size: integer
rank_window_size?: integer
}

export class PinnedRetriever extends RetrieverBase {
/** Inner retriever. */
retriever: RetrieverContainer
ids?: string[]
docs?: SpecifiedDocument[]
rank_window_size: integer
rank_window_size?: integer
}

export class InnerRetriever {
Expand Down Expand Up @@ -145,9 +145,9 @@ export class TextSimilarityReranker extends RetrieverBase {
/** Unique identifier of the inference endpoint created using the inference API. */
inference_id?: string
/** The text snippet used as the basis for similarity comparison */
inference_text?: string
inference_text: string
/** The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text */
field?: string
field: string
}

export class RuleRetriever extends RetrieverBase {
Expand Down