[DOCS] Move field collapse content to separate page (#60424) (#60451)

This commit is contained in:
James Rodewig 2020-07-30 09:19:05 -04:00 committed by GitHub
parent b3da548dab
commit b17ae33b3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 43 additions and 31 deletions

View File

@ -62,7 +62,8 @@ See <<request-body-search-explain>>.
[role="exclude",id="search-request-collapse"]
=== Collapse parameter for request body search API
See <<request-body-search-collapse>>.
See <<collapse-search-results>>.
[role="exclude",id="search-request-from-size"]
=== From and size parameters for request body search API
@ -130,7 +131,8 @@ See <<sort-search-results>>.
[role="exclude",id="search-request-source-filtering"]
=== Source filtering parameter for request body search API
See <<request-body-search-source-filtering>>.
See <<source-filtering>>.
[role="exclude",id="search-request-stored-fields"]
=== Stored fields parameter for request body search API
@ -922,21 +924,21 @@ For search API reference documentation, see <<search-search>>.
For search examples, see <<run-a-search>>.
[role="exclude",id="request-body-search-from-size"]
==== From / size
See <<paginate-search-results>>.
[role="exclude",id="request-body-search-source-filtering"]
==== Source filtering
See <<source-filtering, source filtering>>.
[role="exclude",id="request-body-search-docvalue-fields"]
==== Doc value fields
See <<docvalue-fields, doc value fields>>.
[role="exclude",id="request-body-search-collapse"]
==== Field collapsing
See <<collapse-search-results>>.
[role="exclude",id="request-body-search-from-size"]
==== From / size
See <<paginate-search-results>>.
[role="exclude",id="request-body-search-highlighting"]
==== Highlighting
See <<highlighting>>.
@ -948,4 +950,9 @@ See <<how-highlighters-work-internally>>.
[role="exclude",id="request-body-search-sort"]
==== Sort
See <<sort-search-results>>.
[role="exclude",id="request-body-search-source-filtering"]
==== Source filtering
See <<source-filtering>>.
////

View File

@ -108,9 +108,15 @@ executing a distributed search across the whole cluster and gathering all the
results.
include::request/docvalue-fields.asciidoc[]
[[request-body-search-docvalue-fields]]
==== Doc value fields
include::request/collapse.asciidoc[]
See <<docvalue-fields>>.
[[request-body-search-collapse]]
==== Field collapsing
See <<collapse-search-results>>.
[[request-body-search-highlighting]]
==== Highlighting
@ -144,7 +150,10 @@ include::request/search-type.asciidoc[]
See <<sort-search-results>>.
include::request/source-filtering.asciidoc[]
[[request-body-search-source-filtering]]
==== Source filtering
See <<source-filtering>>.
include::request/stored-fields.asciidoc[]

View File

@ -1,9 +1,10 @@
[[request-body-search-collapse]]
==== Field Collapsing
[[collapse-search-results]]
=== Collapse search results
Allows to collapse search results based on field values.
The collapsing is done by selecting only the top sorted document per collapse key.
For instance the query below retrieves the best tweet for each user and sorts them by number of likes.
You can use the `collapse` parameter to collapse search results based
on field values. The collapsing is done by selecting only the top sorted
document per collapse key. For instance the query below retrieves the best tweet
for each user and sorts them by number of likes.
[source,console]
--------------------------------------------------
@ -34,8 +35,8 @@ The field used for collapsing must be a single valued <<keyword, `keyword`>> or
NOTE: The collapsing is applied to the top hits only and does not affect aggregations.
===== Expand collapse results
[[expand-collapse-results]]
==== Expand collapse results
It is also possible to expand each collapsed top hits with the `inner_hits` option.
@ -117,7 +118,8 @@ The default is based on the number of data nodes and the default search thread p
WARNING: `collapse` cannot be used in conjunction with <<request-body-search-scroll, scroll>>,
<<request-body-search-rescore, rescore>> or <<request-body-search-search-after, search after>>.
===== Second level of collapsing
[[second-level-of-collapsing]]
==== Second level of collapsing
Second level of collapsing is also supported and is applied to `inner_hits`.
For example, the following request finds the top scored tweets for

View File

@ -1,4 +0,0 @@
[[request-body-search-docvalue-fields]]
==== Doc value fields
See <<docvalue-fields, doc value fields>>.

View File

@ -1,4 +0,0 @@
[[request-body-search-source-filtering]]
==== Source filtering
See <<source-filtering, source filtering>>.

View File

@ -272,6 +272,8 @@ include::request/from-size.asciidoc[]
include::search-fields.asciidoc[]
include::request/collapse.asciidoc[]
include::request/highlighting.asciidoc[]
include::request/sort.asciidoc[]