﻿---
title: stack es inference rerank cli command
description: Perform reranking inference on the service. Behaviour flags: --dry-run — validate all inputs and exit without performing any action object example: string...
url: https://www.elastic.co/elastic/docs-builder/docs/4118/reference/elastic-cli/cli/stack/es/inference/rerank
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es inference rerank cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es inference rerank \
  --query <query> \
  --input <input> \
  --inference-id <inference-id> \
  [options]
```

Perform reranking inference on the service.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--query string required">
    Query input.
    The query can be specified as a single string, or as an object.
    The object form additionally allows specifying non-text inputs, such as images. > info
    > Only the `elastic` service currently supports non-text queries for the `rerank` task. For all other services, the query must be a string. string example:
  </definition>
</definitions>

```
"query": "some query text"
```

object example:
```
"query": { "type": "image", "format": "base64", "value": "data:image/jpeg;base64,..."
}
```

<definitions>
  <definition term="--input string required">
    The documents to rank.
    The input can be specified as a single string or an array of strings, or as an object or an array of objects.
    The object form additionally allows specifying non-text inputs, such as images. > info
    > Only the `elastic` service currently supports non-text inputs for the `rerank` task. For all other services, the input must be a string or an array of strings. string example:
  </definition>
</definitions>

```
"input": "some document text"
```

string array example:
```
"input": ["some document text", "some more document text"]
```

object example:
```
"input": { "type": "image", "format": "base64", "value": "data:image/jpeg;base64,..."
}
```

object array example:
```
"input": [ { "type": "text", "format": "text", "value": "some document text" }, { "type": "image", "format": "base64", "value": "data:image/jpeg;base64,..." }
]
```

<definitions>
  <definition term="--inference-id string required">
    The unique identifier for the inference endpoint.
  </definition>
  <definition term="--timeout string">
    The amount of time to wait for the inference request to complete.
  </definition>
  <definition term="--return-documents">
    Include the document text in the response.
  </definition>
  <definition term="--top-n number">
    Limit the response to the top N documents.
  </definition>
  <definition term="--task-settings string">
    Task settings for the individual inference request.
    These settings are specific to the task type you specified and override the task settings specified when initializing the service.
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>