Rerank Model

POST 
https://knox.chat/v1/rerank

Return Rerank Response

The rerank endpoint receives a query, a list of documents, and other parameters (such as model name) as input, and returns a response containing the rerank results.

Headers

Name	Type	Required	Description
Authorization	String	Yes	Bearer authentication in the form of Bearer <token>, where token is your authentication token.

cURL Example

curl --request POST \
     --url https://knox.chat/v1/rerank \
     --header "Authorization: Bearer $KNOXCHAT_API_KEY" \
     --header "content-type: application/json" \
     --data '
{
  "query": "Sample query",
  "documents": [
    "Sample document 1",
    "Sample document 2"
  ],
  "model": "rerank-2"
}
'

Response

Success Response (200)

{
  "object": "list",
  "data": [
    {
      "relevance_score": 0.4375,
      "index": 0
    },
    {
      "relevance_score": 0.421875,
      "index": 1
    }
  ],
  "model": "rerank-2",
  "usage": {
    "total_tokens": 26
  }
}

Response Errors

• 4xx series are client-side errors
• 5xx series are server-side errors