Perform rereanking inference on the service | Elasticsearch Serverless API documentation

Perform rereanking inference on the service Added in 8.11.0

POST /_inference/rerank/{inference_id}

Path parameters

inference_id string Required

The unique identifier for the inference endpoint.

Query parameters

timeout string

The amount of time to wait for the inference request to complete.

application/json

Body

query string Required

Query input.
input string | array[string] Required

The text on which you want to perform the inference task. It can be a single string or an array.

Inference endpoints for the completion task type currently only support a single string as input.

One of:
string-1 string array-2 array[string]
task_settings object

Additional properties are allowed.

Responses

200 application/json
Hide response attribute Show response attribute object
- rerank array[object] Required
  
  Hide rerank attributes Show rerank attributes object
  
  index number Required
  
  relevance_score number Required
  
  text string

POST /_inference/rerank/{inference_id}

curl \
 --request POST http://api.example.com/_inference/rerank/{inference_id} \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"query":"string","input":"string","task_settings":{}}'