Skip to main content

Document Rerank

POST /v1/rerank

Request Parameters​

ParameterTypeRequiredDescription
modelstringRequired-
querystringRequiredQuery text
documentsarray<string | object>RequiredList of documents to rerank
top_nintegerOptionalReturn top N results
return_documentsbooleanOptional-

Request Example​

{
"body": {
"model": "rerank-english-v2.0",
"query": "string",
"documents": [
"string"
]
}
}

Response Fields(200)​

Field NameTypeDescription
modelstring-
querystringp p-0 Query text
documentsarray<string | object>p p-0 List of documents to rerank
top_nintegerp p-0 Return top N results
return_documentsboolean-