Skip to content

docs: add sort note in pinned_query #131350

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 4 commits into from
Aug 5, 2025
+4 −0
Merged

docs: add sort note in pinned_query #131350

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6011c0
docs: add sort note in pinned_query
mromaios Jul 15, 2025
18a2775
Merge remote-tracking branch 'mromaios/main' into pinned_query_sort_d…
mromaios Jul 16, 2025
b3b2748
Merge branch 'main' into pinned_query_sort_doc_update
mromaios Jul 16, 2025
0d923ba
Merge branch 'main' into pinned_query_sort_doc_update
mromaios Jul 28, 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
4 changes: 4 additions & 0 deletions docs/reference/query-languages/query-dsl/query-dsl-pinned-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ mapped_pages:

Promotes selected documents to rank higher than those matching a given query. This feature is typically used to guide searchers to curated documents that are promoted over and above any "organic" matches for a search. The promoted or "pinned" documents are identified using the document IDs stored in the [`_id`](/reference/elasticsearch/mapping-reference/mapping-id-field.md) field.

::::{note}
Pinned queries are designed to work only with relevance-based sorting. Using explicit `sort` criteria overrides the pinned document promotion.
::::

## Example request [_example_request]

```console
Expand Down
Loading