elasticsearch/docs/reference/query-languages/esql/_snippets/commands/layout/rerank.md

serverless: preview
stack: preview 9.2.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.

Syntax

RERANK [column =] query ON field [, field, ...] [WITH { "inference_id" : "my_inference_endpoint" }]

Parameters

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.

Description

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.

Requirements

To use this command, you must deploy your reranking model in Elasticsearch as an inference endpoint with the task type rerank.

Handling timeouts

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}}

• You can adjust {{es}} settings in the Elastic Cloud Console
• You can also adjust the search.default_search_timeout cluster setting using Kibana's Advanced settings :::

:::{tab-item} Self-managed

• You can configure at the cluster level by setting search.default_search_timeout in elasticsearch.yml or updating via Cluster Settings API
• You can also adjust the search:timeout setting using Kibana's Advanced settings
• Alternatively, you can add timeout parameters to individual queries :::

:::{tab-item} {{serverless-full}}

• Requires a manual override from Elastic Support because you cannot modify timeout settings directly ::: ::::

If you don't want to increase the timeout limit, try the following:

• Reduce data volume with LIMIT or more selective filters before the RERANK command
• Split complex operations into multiple simpler queries
• Configure your HTTP client's response timeout (Refer to HTTP client configuration)

Examples

Rerank search results using a simple query and a single field:

:::{include} ../examples/rerank.csv-spec/simple-query.md :::

Rerank search results using a query and multiple fields, and store the new score in a column named rerank_score:

:::{include} ../examples/rerank.csv-spec/two-queries.md :::

Combine the original score with the reranked score:

:::{include} ../examples/rerank.csv-spec/combine.md :::