Skip to content

Commit c0dc884

Browse files
authored
9.1 docs backports for 8.19 features (#132605)
1 parent 978261f commit c0dc884

File tree

3 files changed

+62
-22
lines changed

3 files changed

+62
-22
lines changed

docs/reference/index-modules.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,10 @@ pipeline attempts to change the `_index` field, the indexing request will fail.
378378
per request through the use of the `expand_wildcards` parameter. Possible values are
379379
`true` and `false` (default).
380380

381+
[[index-esql-stored-fields-sequential-proportion]] `index.esql.stored_fields_sequential_proportion`::
382+
383+
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.
384+
381385
[discrete]
382386
=== Settings in other index modules
383387

docs/reference/search/retriever.asciidoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ A <<text-similarity-reranker-retriever, retriever>> that enhances search results
4343
`rule`::
4444
A <<rule-retriever, retriever>> that applies contextual <<query-rules>> to pin or exclude documents for specific queries.
4545

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+
4649
[[standard-retriever]]
4750
==== Standard Retriever
4851

@@ -946,6 +949,60 @@ GET movies/_search
946949
<1> The `rule` retriever is the outermost retriever, applying rules to the search results that were previously reranked using the `rrf` retriever.
947950
<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.
948951

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.
956+
957+
[discrete]
958+
[[retrievers-overview-pinned-retriever-parameters]]
959+
===== Parameters
960+
961+
`ids`::
962+
(Optional, array of strings)
963+
+
964+
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.
975+
976+
Either `ids` or `docs` must be specified.
977+
978+
[discrete]
979+
[[pinned-retriever-example]]
980+
==== Example: Pinned retriever using `docs
981+
982+
[source,console]
983+
----
984+
GET /restaurants/_search
985+
{
986+
"retriever": {
987+
"pinned": {
988+
"docs": [
989+
{ "_id": "doc1", "_index": "my-index" },
990+
{ "_id": "doc2" }
991+
],
992+
"retriever": {
993+
"standard": {
994+
"query": {
995+
"match": {
996+
"title": "elasticsearch"
997+
}
998+
}
999+
}
1000+
}
1001+
}
1002+
}
1003+
}
1004+
----
1005+
9491006
[discrete]
9501007
[[multi-field-query-format]]
9511008
=== Multi-field query format

docs/reference/search/search-your-data/retrievers-overview.asciidoc

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -69,30 +69,9 @@ Applies <<query-rules,query rules>> to the query before returning results.
6969
* <<text-similarity-reranker-retriever,*Text Similarity Re-ranker Retriever*>>.
7070
Used for <<semantic-reranking,semantic reranking>>.
7171
Requires first creating a `rerank` task using the <<put-inference-api,{es} Inference API>>.
72-
* <<retrievers-overview-pinned-retriever-parameters,*Pinned Retriever*>>.
72+
* <<pinned-retriever,*Pinned Retriever*>>.
7373
Returns top documents by always placing specific documents at the top of the results, with the remaining hits provided by a secondary retriever.
7474

75-
[discrete]
76-
[[retrievers-overview-pinned-retriever-parameters]]
77-
==== Pinned Retriever Parameters
78-
79-
`ids`::
80-
(Optional, array of strings)
81-
+
82-
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.
93-
94-
Either `ids` or `docs` must be specified.
95-
9675
[discrete]
9776
[[retrievers-overview-why-are-they-useful]]
9877
=== What makes retrievers useful?

0 commit comments

Comments
 (0)