docs/reference/query-languages/esql/_snippets/commands/layout/rerank.md
serverless: ga
stack: preview 9.2-9.3, ga 9.4.0+
The RERANK command uses an inference model to compute a new relevance score
for an initial set of documents, directly within your ES|QL queries.
::::{tab-set}
:::{tab-item} 9.3.0+
Starting in version 9.3.0, RERANK automatically limits processing to 1000
rows by default to prevent accidental high consumption. This limit is applied
before the RERANK command executes.
If you need to process more rows, you can adjust the limit using the cluster setting:
PUT _cluster/settings
{
"persistent": {
"esql.command.rerank.limit": 5000
}
}
You can also disable the command entirely if needed:
PUT _cluster/settings
{
"persistent": {
"esql.command.rerank.enabled": false
}
}
:::
:::{tab-item} 9.2.x
No automatic row limit is applied. You should always use LIMIT before or after RERANK to control the number of documents processed, to avoid accidentally reranking large datasets which can result in high latency and increased costs.
For example:
FROM books
| WHERE title:"search query"
| SORT _score DESC
| LIMIT 100 // Limit to top 100 results before reranking
| RERANK "search query" ON title WITH { "inference_id" : "my_rerank_endpoint" }
:::
::::
RERANK [column =] query ON field [, field, ...] [WITH { "inference_id" : "my_inference_endpoint" }]
column
: (Optional) The name of the output column containing the reranked scores.
If not specified, the results will be stored in a column named _score.
If the specified column already exists, it will be overwritten with the new
results.
query
: The query text used to rerank the documents. This is typically the same
query used in the initial search.
field
: One or more fields to use for reranking. These fields should contain the
text that the reranking model will evaluate.
my_inference_endpoint
: The ID of
the inference endpoint
to use for the task.
The inference endpoint must be configured with the rerank task type.
The RERANK command uses an inference model to compute a new relevance score
for an initial set of documents, directly within your ES|QL queries.
Typically, you first use a WHERE clause with a function like MATCH to
retrieve an initial set of documents. This set is often sorted by _score and
reduced to the top results (for example, 100) using LIMIT. The RERANK
command then processes this smaller, refined subset, which is a good balance
between performance and accuracy.
When using RERANK with a multivalue column, each value is ranked individually.
The score column is then assigned the maximum score resulting from ranking the
individual values.
To use this command, you must deploy your reranking model in Elasticsearch as
an inference endpoint
with the
task type rerank.
RERANK commands may time out when processing large datasets or complex
queries. The default timeout is 10 minutes, but you can increase this limit if
necessary.
How you increase the timeout depends on your deployment type:
::::{tab-set} :::{tab-item} {{ech}}
search.default_search_timeout cluster setting
using Kibana's Advanced settings
::::::{tab-item} Self-managed
search.default_search_timeout in elasticsearch.yml or updating
via Cluster Settings APIsearch:timeout setting
using Kibana's Advanced settings:::{tab-item} {{serverless-full}}
If you don't want to increase the timeout limit, try the following:
LIMIT or more selective filters before the RERANK
command:::{include} ../examples/rerank.csv-spec/simple-query.md :::
:::{include} ../examples/rerank.csv-spec/two-queries.md :::
:::{include} ../examples/rerank.csv-spec/combine.md :::
:::{include} ../examples/rerank.csv-spec/rerank-top-snippets.md :::