You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Tuning parameter for deciding when ES|QL will load <<search-fields-request,stored fields>> using a strategy tuned for loading dense sequence of documents. Allows values between 0.0 and 1.0 and defaults to 0.2. Indices with documents smaller than 10kb may see speed improvements loading `text` fields by setting this lower.
Copy file name to clipboardExpand all lines: docs/reference/search/retriever.asciidoc
+57Lines changed: 57 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,9 @@ A <<text-similarity-reranker-retriever, retriever>> that enhances search results
43
43
`rule`::
44
44
A <<rule-retriever, retriever>> that applies contextual <<query-rules>> to pin or exclude documents for specific queries.
45
45
46
+
`pinned`::
47
+
A <<pinned-retriever, retriever>> that always places specified documents at the top of the results, with the remaining hits provided by a secondary retriever.
48
+
46
49
[[standard-retriever]]
47
50
==== Standard Retriever
48
51
@@ -946,6 +949,60 @@ GET movies/_search
946
949
<1> The `rule` retriever is the outermost retriever, applying rules to the search results that were previously reranked using the `rrf` retriever.
947
950
<2> The `rrf` retriever returns results from all of its sub-retrievers, and the output of the `rrf` retriever is used as input to the `rule` retriever.
948
951
952
+
[[pinned-retriever]]
953
+
==== Pinned retriever
954
+
955
+
A `pinned` retriever returns top documents by always placing specific documents at the top of the results, with the remaining hits provided by a secondary retriever. This retriever offers similar functionality to the <<query-dsl-pinned-query,pinned query>>, but works seamlessly with other retrievers. This is useful for promoting certain documents for particular queries, regardless of their relevance score.
A list of document IDs to pin at the top of the results, in the order provided.
965
+
966
+
`docs`::
967
+
(Optional, array of objects)
968
+
+
969
+
List of objects specifying documents to pin. Each object must contain at least an `_id` field, and may also specify `_index` if pinning documents across multiple indices.
970
+
971
+
`retriever`::
972
+
(Optional, retriever object)
973
+
+
974
+
A retriever (for example a `standard` retriever or a specialized retriever such as `rrf` retriever) used to retrieve the remaining documents after the pinned ones.
A list of document IDs to pin at the top of the results, in the order provided.
83
-
84
-
`docs`::
85
-
(Optional, array of objects)
86
-
+
87
-
List of objects specifying documents to pin. Each object must contain at least an `_id` field, and may also specify `_index` if pinning documents across multiple indices.
88
-
89
-
`retriever`::
90
-
(Optional, retriever object)
91
-
+
92
-
A retriever (for example a `standard` retriever or a specialized retriever such as `rrf` retriever) used to retrieve the remaining documents after the pinned ones.
0 commit comments