Models Hub
API ReferenceAudio & Others

Document reranking.

Rerank a list of documents by relevance to a query.

Edit this page
POST
/v1/rerank

Authorization

bearerAuth
AuthorizationBearer <token>

Authenticate using an Authorization Bearer API Key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "rerank-english-v2.0",    "query": "string",    "documents": [      "string"    ]  }'
{
  "id": "string",
  "results": [
    {
      "index": 0,
      "relevance_score": 0,
      "document": {}
    }
  ],
  "meta": {}
}