Skip to content

Commit 785803b

Browse files
authored
docs: add sort note in pinned_query (#131350)
1 parent c8210a3 commit 785803b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/reference/query-languages/query-dsl/query-dsl-pinned-query.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ mapped_pages:
77

88
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.
99

10+
::::{note}
11+
Pinned queries are designed to work only with relevance-based sorting. Using explicit `sort` criteria overrides the pinned document promotion.
12+
::::
13+
1014
## Example request [_example_request]
1115

1216
```console

0 commit comments

Comments
 (0)