Rerank

Re-ranks a list of documents against a query using an embedding/rerank model.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

BAAI/bge-reranker-base.

query*string

Query to rank documents against.

documents*array<>

List of documents to rerank.

top_n?integer

Number of top documents to return.

Range1 <= value

return_documents?boolean

Whether to include document text in the response.

Defaulttrue

user?string

End-user identifier.

Response Body

`application/json`

curl -X POST "https://api.vivgrid.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "BAAI/bge-reranker-base",    "query": "What is fast text search?",    "documents": [      "Text search indexes terms for fast lookup.",      "Weather today is sunny."    ],    "top_n": 1  }'

{
  "object": "string",
  "model": "string",
  "results": [
    {
      "index": 0,
      "relevance_score": 0,
      "document": "string"
    }
  ]
}

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Rerank

Authorization

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`