Find reranking providers (HTTP)
|
For details about additional languages, see: |
Gets information about reranking providers for the find and rerank command, including supported providers, models, and configuration parameters.
Different databases might have different models available.
|
You need an application token with permission to interact with the target database, such as the Database Administrator role. For more information, see Get endpoint and token. |
Result
Returns an object that contains information about the reranking providers.
Example response, truncated for brevity:
{
"status": {
"rerankingProviders": {
"nvidia": {
"isDefault": true,
"displayName": "Nvidia",
"supportedAuthentication": {
"NONE": {
"enabled": true,
"tokens": []
}
},
"models": [
{
"name": "nvidia/llama-3.2-nv-rerankqa-1b-v2",
"isDefault": true,
"url": "https://...",
"properties": null
}
]
}
}
}
}Signature
Use the findRerankingProviders Data API command.
The application token must have sufficient permissions to perform the requested operations, such as the Database Administrator role.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findRerankingProviders": {
"options": {
"filterModelStatus": "STATUS"
}
}
}'Parameters
| Name | Type | Summary |
|---|---|---|
|
|
Optional.
Filters the available models by status.
Can be one of: Default: |
Examples
The following examples demonstrate how to find reranking providers.
curl -sS -L -X POST "API_ENDPOINT/api/json/v1" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findRerankingProviders": {
"options": {
"filterModelStatus": "SUPPORTED"
}
}
}'