POST
/
v3
/
openai
/
rerank
Create rerank
curl --request POST \
  --url https://api.novita.ai/v3/openai/rerank \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 123
}'
{
  "id": "<string>",
  "results": [
    {
      "document": {
        "text": "<string>"
      },
      "index": 123,
      "relevance_score": 123
    }
  ],
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}
Creates a rerank request.

Request Headers

Content-Type
string
required
Enum: application/json
Authorization
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

Request Body

model
string
required
The name of the model to use.
query
string
required
The search query.
documents
string[]
required
Document List.
top_n
integer
Number of most relevant documents or indices to return.

Response

id
string
required
ID
results
object[]
required
usage
object
Token usage statistics.