Find reranking providers (TypeScript)
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 a promise that resolves to a FindRerankingProvidersResult object that contains information about the reranking providers.
The object contains a single key, rerankingProviders, which holds an untyped map with provider names as keys, and objects describing the provider as values.
Signature
Use the findRerankingProviders method, which belongs to the DbAdmin class.
async findRerankingProviders(
options?: {
filterModelStatus?: ModelLifecycleStatus | '',
timeout: number | TimeoutDescriptor,
}
): FindRerankingProvidersResult;Parameters
| Name | Type | Summary |
|---|---|---|
|
|
Optional.
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Filters the available models by status. Default: |
|
|
Optional. The client-side timeout for this operation. |
Examples
The following examples demonstrate how to find reranking providers.
import { DataAPIClient } from "@datastax/astra-db-ts";
const client = new DataAPIClient("APPLICATION_TOKEN");
const admin = client.admin();
const databaseAdmin = admin.dbAdmin("API_ENDPOINT");
(async function () {
const providers = await databaseAdmin.findRerankingProviders();
console.log(JSON.stringify(providers));
})();Client reference
For more information, see the client reference.
