Skip to content

[docs] nested knn only supports score_mode max #125582

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 2 commits into from
Mar 26, 2025
Merged

[docs] nested knn only supports score_mode max #125582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baf6402
[docs] nested knn only supports score_mode max
tteofili Mar 25, 2025
aaedbd8
added note to query-dsl-knn
tteofili Mar 26, 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
3 changes: 2 additions & 1 deletion docs/reference/query-languages/query-dsl/query-dsl-knn-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ POST my-image-index/_search

A sample query can look like below:

```js
```json
{
"query" : {
"nested" : {
Expand All @@ -226,6 +226,7 @@ A sample query can look like below:
}
```

Note that nested `knn` only supports `score_mode=max`.

## Knn query with aggregations [knn-query-aggregations]

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/query-languages/query-dsl/query-dsl-nested-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ See [Multi-level nested queries](#multi-level-nested-query-ex) for an example.


`score_mode`
: (Optional, string) Indicates how scores for matching child objects affect the root parent document’s [relevance score](/reference/query-languages/query-dsl/query-filter-context.md#relevance-scores). Valid values are:
: (Optional, string) Indicates how scores for matching child objects affect the root parent document’s [relevance score](/reference/query-languages/query-dsl/query-filter-context.md#relevance-scores). Default is `avg`, but nested `knn` queries only support `score_mode=max`. Valid values are:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind also putting a reference on query-dsl-knn-query.md There is a section there on Knn query inside a nested query

Also, it seems like we need to also now update: https://github.com/elastic/docs-content/blob/main/solutions/search/vector/knn.md in a separate PR.


`avg` (Default)
: Use the mean relevance score of all matching child objects.
Expand Down
Loading