Skip to content

[Website]: Confusing Indentation in Knn query Docs for oversample Parameter #2335

@ERosendo

Description

@ERosendo

Type of issue

Inaccurate

What documentation page is affected

https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query

What happened?

I was reading the k-NN query DSL documentation at this link and initially misunderstood how to apply the oversample parameter. The way it's presented (without indentation) led me to believe it was a top-level field of the Knn query. However, through testing, I realized oversample is actually a nested parameter under rescore_vector.

This lack of visual hierarchy in the documentation made it challenging to understand the query structure.

Here’s a screenshot from the latest version of the docs showing how rescore_vector and oversample are currently displayed:

Image

Additional info

No response

Metadata

Metadata

Assignees

Labels

Team:DeveloperIssues owned by the Developer Docs Teamcommunitygood first issueGood for newcomerssource:webIssues originating from the elastic.co docs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions