Text Embeddings Inference

Get Ranks. Returns a 424 status code if the model is not a Sequence Classification model with

a single class.

post/rerank

Request body

querystring required

raw_scoresboolean

return_textboolean

textsstring[] required

truncateboolean nullable

truncation_direction'Left' | 'Right'

Example request

{
  "query": "What is Deep Learning?",
  "texts": [
    "Deep Learning is ..."
  ]
}

Response

Ranks

indexinteger required

scorenumber float required

textstring nullable

Example response

[
  {
    "text": "Deep Learning is ..."
  }
]

Changes

Changed in 5 of the 42 revisions of this API.276

Sep 1, 20259988d0e8962041See the full diff
- ●
  added the new Empty enum value to the error_type response property for the response status 413
  response-property-enum-value-added
- ●
  added the new Empty enum value to the error_type response property for the response status 422
  response-property-enum-value-added
- ●
  added the new Empty enum value to the error_type response property for the response status 424
  response-property-enum-value-added
- ●
  added the new Empty enum value to the error_type response property for the response status 429
  response-property-enum-value-added
- ○
  added the non-success response with the status 400
  response-non-success-status-added
Jun 28, 2024b923798e38682See the full diff
- ○
  added the new optional request property truncation_direction
  new-optional-request-property
- ○
  the request property truncate became nullable
  request-property-became-nullable
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 20, 2023d2b376630853132See the full diff
- ▲
  added the new required request property texts
  new-required-request-property
- ●
  removed the request property passages
  request-property-removed
- ●
  removed the request property return_passages
  request-property-removed
- ●
  removed the optional property items/passage from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional request property return_text
  new-optional-request-property
- ○
  added the optional property items/text to the response with the 200 status
  response-optional-property-added
Nov 20, 20230a226ee52ce31See the full diff
- ○
  endpoint added
  endpoint-added
Oct 13, 20238c00768ef7031See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 30 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history