Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion docs/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,16 @@ redirects:
- to: 'reference/query-languages/esql/commands/stats-by.md'
anchors: {'esql-stats-by'}
- to: 'reference/query-languages/esql/commands/where.md'
anchors: {'esql-where'}
anchors: {'esql-where'}

# https://github.com/elastic/elasticsearch/pull/133359
'reference/elasticsearch/rest-apis/filter-search-results.md':
to: 'reference/elasticsearch/rest-apis/filter-search-results.md'
anchors: {} # pass-through unlisted anchors in the `many` ruleset
many:
- to: 'reference/elasticsearch/rest-apis/rescore-search-results.md'
anchors: {'rescore'}
- to: 'reference/elasticsearch/rest-apis/rescore-search-results.md'
anchors: {'query-rescorer'}
- to: 'reference/elasticsearch/rest-apis/rescore-search-results.md'
anchors: {'multiple-rescores'}
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you **only** need `docvalue_fields`, `size`, and `sort` then [Top metrics](/r
::::


`top_hits` does not support the [`rescore`](/reference/elasticsearch/rest-apis/filter-search-results.md#rescore) parameter. Query rescoring applies only to search hits, not aggregation results. To change the scores used by aggregations, use a [`function_score`](/reference/query-languages/query-dsl/query-dsl-function-score-query.md) or [`script_score`](/reference/query-languages/query-dsl/query-dsl-script-score-query.md) query.
`top_hits` does not support the [`rescore`](/reference/elasticsearch/rest-apis/rescore-search-results.md#rescore) parameter. Query rescoring applies only to search hits, not aggregation results. To change the scores used by aggregations, use a [`function_score`](/reference/query-languages/query-dsl/query-dsl-function-score-query.md) or [`script_score`](/reference/query-languages/query-dsl/query-dsl-script-score-query.md) query.


## Example [_example_6]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ GET /my-index-000001/_search

## Rescore collapse results [rescore-collapse-results]

You can use field collapsing alongside the [`rescore`](/reference/elasticsearch/rest-apis/filter-search-results.md#rescore) search parameter. Rescorers run on every shard for the top-ranked document per collapsed field. To maintain a reliable order, it is recommended to cluster documents sharing the same collapse field value on one shard. This is achieved by assigning the collapse field value as the [routing key](/reference/elasticsearch/rest-apis/search-shard-routing.md#search-routing) during indexing:
You can use field collapsing alongside the [`rescore`](/reference/elasticsearch/rest-apis/rescore-search-results.md#rescore) search parameter. Rescorers run on every shard for the top-ranked document per collapsed field. To maintain a reliable order, it is recommended to cluster documents sharing the same collapse field value on one shard. This is achieved by assigning the collapse field value as the [routing key](/reference/elasticsearch/rest-apis/search-shard-routing.md#search-routing) during indexing:

```console
POST /my-index-000001/_doc?routing=xyz <1>
Expand All @@ -189,7 +189,7 @@ POST /my-index-000001/_doc?routing=xyz <1>

By doing this, you guarantee that only one top document per collapse key gets rescored globally.

The following request utilizes field collapsing on the `user.id` field and then rescores the top groups with a [query rescorer](/reference/elasticsearch/rest-apis/filter-search-results.md#query-rescorer):
The following request utilizes field collapsing on the `user.id` field and then rescores the top groups with a [query rescorer](/reference/elasticsearch/rest-apis/rescore-search-results.md#query-rescorer):

```console
GET /my-index-000001/_search
Expand Down
123 changes: 0 additions & 123 deletions docs/reference/elasticsearch/rest-apis/filter-search-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ You can use two methods to filter search results:
* Use a boolean query with a `filter` clause. Search requests apply [boolean filters](/reference/query-languages/query-dsl/query-dsl-bool-query.md) to both search hits and [aggregations](/reference/aggregations/index.md).
* Use the search API’s `post_filter` parameter. Search requests apply [post filters](#post-filter) only to search hits, not aggregations. You can use a post filter to calculate aggregations based on a broader result set, and then further narrow the results.

You can also [rescore](#rescore) hits after the post filter to improve relevance and reorder results.



## Post filter [post-filter]

When you use the `post_filter` parameter to filter search results, the search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.
Expand Down Expand Up @@ -125,122 +121,3 @@ GET /shirts/_search
2. The `colors` agg returns popular colors for shirts by Gucci.
3. The `color_red` agg limits the `models` sub-aggregation to **red** Gucci shirts.
4. Finally, the `post_filter` removes colors other than red from the search `hits`.



## Rescore filtered search results [rescore]

Rescoring can help to improve precision by reordering just the top (eg 100 - 500) documents returned by the [`query`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) and [`post_filter`](#post-filter) phases, using a secondary (usually more costly) algorithm, instead of applying the costly algorithm to all documents in the index.

A `rescore` request is executed on each shard before it returns its results to be sorted by the node handling the overall search request.

Currently the rescore API has only one implementation: the query rescorer, which uses a query to tweak the scoring. In the future, alternative rescorers may be made available, for example, a pair-wise rescorer.

::::{note}
An error will be thrown if an explicit [`sort`](/reference/elasticsearch/rest-apis/sort-search-results.md) (other than `_score` in descending order) is provided with a `rescore` query.
::::


::::{note}
when exposing pagination to your users, you should not change `window_size` as you step through each page (by passing different `from` values) since that can alter the top hits causing results to confusingly shift as the user steps through pages.
::::



### Query rescorer [query-rescorer]

The query rescorer executes a second query only on the Top-K results returned by the [`query`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) and [`post_filter`](#post-filter) phases. The number of docs which will be examined on each shard can be controlled by the `window_size` parameter, which defaults to 10.

By default the scores from the original query and the rescore query are combined linearly to produce the final `_score` for each document. The relative importance of the original query and of the rescore query can be controlled with the `query_weight` and `rescore_query_weight` respectively. Both default to `1`.

For example:

```console
POST /_search
{
"query" : {
"match" : {
"message" : {
"operator" : "or",
"query" : "the quick brown"
}
}
},
"rescore" : {
"window_size" : 50,
"query" : {
"rescore_query" : {
"match_phrase" : {
"message" : {
"query" : "the quick brown",
"slop" : 2
}
}
},
"query_weight" : 0.7,
"rescore_query_weight" : 1.2
}
}
}
```

The way the scores are combined can be controlled with the `score_mode`:

| Score Mode | Description |
| --- | --- |
| `total` | Add the original score and the rescore query score. The default. |
| `multiply` | Multiply the original score by the rescore query score. Usefulfor [`function query`](/reference/query-languages/query-dsl/query-dsl-function-score-query.md) rescores. |
| `avg` | Average the original score and the rescore query score. |
| `max` | Take the max of original score and the rescore query score. |
| `min` | Take the min of the original score and the rescore query score. |


### Multiple rescores [multiple-rescores]

It is also possible to execute multiple rescores in sequence:

```console
POST /_search
{
"query" : {
"match" : {
"message" : {
"operator" : "or",
"query" : "the quick brown"
}
}
},
"rescore" : [ {
"window_size" : 100,
"query" : {
"rescore_query" : {
"match_phrase" : {
"message" : {
"query" : "the quick brown",
"slop" : 2
}
}
},
"query_weight" : 0.7,
"rescore_query_weight" : 1.2
}
}, {
"window_size" : 10,
"query" : {
"score_mode": "multiply",
"rescore_query" : {
"function_score" : {
"script_score": {
"script": {
"source": "Math.log10(doc.count.value + 2)"
}
}
}
}
}
} ]
}
```

The first one gets the results of the query then the second one gets the results of the first, etc. The second rescore will "see" the sorting done by the first rescore so it is possible to use a large window on the first rescore to pull documents into a smaller window for the second rescore.

Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The `rrf` retriever does not currently support:

* [scroll](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search#search-api-scroll-query-param)
* [sort](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search#search-sort-param)
* [rescore](/reference/elasticsearch/rest-apis/filter-search-results.md#rescore)
* [rescore](/reference/elasticsearch/rest-apis/rescore-search-results.md#rescore)

Using unsupported features as part of a search with an `rrf` retriever results in an exception.

Expand Down
Loading
Loading