Skip to content

Update multi-field query format docs to indicate serverless support #137591

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

Closed
wants to merge 9 commits into from
+7 −6
Closed

Update multi-field query format docs to indicate serverless support #137591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e7bf2c4
Update applies_to to mention serverless
Mikep86 Nov 4, 2025
369cc77
Update linear retriever documentation for serverless support
Mikep86 Nov 4, 2025
abdaee1
Update rrf retriever docs to indicate serverless support
Mikep86 Nov 4, 2025
11550cb
Fix formatting for query and fields parameters
Mikep86 Nov 4, 2025
2499cca
Update applies_to formatting in rrf-retriever.md
Mikep86 Nov 4, 2025
f6185b9
Update linear retriever applies_to tags
Mikep86 Nov 4, 2025
80c3698
Update applies_to tags in linear retriever documentation
Mikep86 Nov 4, 2025
b1936b1
Update rrf query and fields applies_to tags
Mikep86 Nov 4, 2025
582a10f
Whitespace
Mikep86 Nov 4, 2025
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
1 change: 1 addition & 0 deletions docs/reference/elasticsearch/rest-apis/retrievers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ When a retriever is specified as part of a search, the following elements are no
## Multi-field query format [multi-field-query-format]
```yaml {applies_to}
stack: ga 9.1
serverless: ga
```

The [`linear`](retrievers/linear-retriever.md) and [`rrf`](retrievers/rrf-retriever.md) retrievers support a multi-field query format that provides a simplified way to define searches across multiple fields without explicitly specifying inner retrievers.
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/elasticsearch/rest-apis/retrievers/linear-retriever.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Either `query` or `retrievers` must be specified.
Combining `query` and `retrievers` is not supported.
::::

`query` {applies_to}`stack: ga 9.1`
`query` {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1`
: (Optional, String)

The query to use when using the [multi-field query format](../retrievers.md#multi-field-query-format).

`fields` {applies_to}`stack: ga 9.1`
`fields` {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1`
: (Optional, array of strings)

The fields to query when using the [multi-field query format](../retrievers.md#multi-field-query-format).
Fields can include boost values using the `^` notation (e.g., `"field^2"`).
If not specified, uses the index's default fields from the `index.query.default_field` index setting, which is `*` by default.

`normalizer` {applies_to}`stack: ga 9.1`
`normalizer` {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1`
: (Optional, String)

The top-level normalizer to use when combining results.
Expand All @@ -37,7 +37,7 @@ Combining `query` and `retrievers` is not supported.

When used with the [multi-field query format](../retrievers.md#multi-field-query-format) (`query` parameter), normalizes scores per [field grouping](../retrievers.md#multi-field-field-grouping).

Otherwise this serves as the default normalizer for any sub-retriever that doesn't specify its own normalizer. Per-retriever normalizers always take precedence over the top-level normalizer. {applies_to}`stack: ga 9.2`
Otherwise this serves as the default normalizer for any sub-retriever that doesn't specify its own normalizer. Per-retriever normalizers always take precedence over the top-level normalizer. {applies_to}`serverless: ga` {applies_to}`stack: ga 9.2`

::::{warning}
Avoid using `none` as that will disable normalization and may bias the result set towards lexical matches.
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/elasticsearch/rest-apis/retrievers/rrf-retriever.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Either `query` or `retrievers` must be specified.
Combining `query` and `retrievers` is not supported.
::::

`query` {applies_to}`stack: ga 9.1`
`query` {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1`
: (Optional, String)

The query to use when using the [multi-field query format](../retrievers.md#multi-field-query-format).

`fields` {applies_to}`stack: ga 9.1`
`fields` {applies_to}`serverless: ga` {applies_to}`stack: ga 9.1`
: (Optional, array of strings)

The fields to query when using the [multi-field query format](../retrievers.md#multi-field-query-format).
Expand Down