Get Ranks

Runs Reranker. Returns a 424 status code if the model is not a Reranker model.

Raw Json

{
  "query": "What are some good electric cars",
  "texts": [
      "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ...",
      "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
  ],
  "raw_scores": false,
  "return_text": false,
  "truncate": false,
  "truncation_direction": "right"
}

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{
      "query": "What are some good electric cars",
      "texts": [
          "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ...",
          "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
      ],
      "raw_scores": false,
      "return_text": false,
      "truncate": false,
      "truncation_direction": "right"
    }' \
     --url http://$ENDPOINT/rerank

import requests

endpoint = "<your-custom-endpoint>"

requests.post(f"{endpoint}/rerank", json={
    "query": "What are some good electric cars",
    "texts": [
      "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ...",
      "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
    ],
    "raw_scores": False,
    "return_text": False,
    "truncate": False,
    "truncation_direction": "right"
});

## or 

requests.post(f"{endpoint}/rerank", json={
    "inputs": "test single input"
});

200 Ranks

[
    {
        "index":1,
        "score":0.15253653,
        // if return_text = true
        "text": "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
    },
    {
        "index":0,
        "score":0.00498227
        // if return_text = true
        "text": "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ..."
    }
]

{
    "error": "Batch size error",
    "error_type": "validation"
}

{
    "error": "Tokenization error",
    "error_type": "validation"
}

{
    "error": "Inference failed",
    "error_type": "backend"
}

{
    "error": "Model is overloaded",
    "error_type": "overloaded"
}

query · string · required

Inputs that need to be embedded

texts · string[] · required

Inputs that need to be embedded

raw_scores · boolean · default: "false"

Output the raw reranker score or the normalized score between 0-1. When false, score is between 0 and 1, otherwise range is indeterminate

return_text · boolean · default: "false"

Return the text with along with each rank

truncate · boolean · default: "false"

Automatically truncate inputs that are longer than the maximum supported size

truncate_direction · "right" | "left" · default: "right"