Perform reranking inference on the service
- POST /_inference/rerank/{inference_id}
- Cluster privileges:
monitor_inference
Path Parameters
-
inference_idstring Idrequired -
The unique identifier for the inference endpoint.
Query Parameters
-
timeoutstring Duration · default: 30s The amount of time to wait for the inference request to complete.
Request
-
queryRerankQueryrequired -
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
elasticservice currently supports non-text queries for thereranktask. For all other services, the query must be a string.string example:
"query": "some query text"object example:
"query": { "type": "image", "format": "base64", "value": "data:image/jpeg;base64,..." } -
inputRerankInputrequired -
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
elasticservice currently supports non-text inputs for thereranktask. For all other services, the input must be a string or an array of strings.string example:
"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,..." } ] -
return_documentsboolean -
Include the document text in the response.
-
top_nnumber -
Limit the response to the top N documents.
-
task_settingsTaskSettings -
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.
Response
-
rerankRankedDocumentrequired -
indexnumberrequired -
relevance_scorenumberrequired -
textstring