Interface FindRerankingProvidersOptions

Options for finding reranking providers.

Field

filterModelStatus - Filter models by their lifecycle status. If not provided, defaults to 'SUPPORTED' only. Use empty string '' to include all statuses.

See

DbAdmin.findRerankingProviders

interface FindRerankingProvidersOptions {
    filterModelStatus?: "" | ModelLifecycleStatus;
    maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`";
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "databaseAdminTimeoutMs">;
}

Hierarchy (view full)

  • CommandOptions<{
        timeout: "databaseAdminTimeoutMs";
    }>
    • FindRerankingProvidersOptions

Properties

filterModelStatus? maxTimeMS? timeout?

Properties

Optional filterModelStatus

filterModelStatus?: "" | ModelLifecycleStatus

Filter models by their lifecycle status.

  • If not provided: defaults to 'SUPPORTED' only
  • If set to '': includes all statuses ('SUPPORTED', 'DEPRECATED', 'END_OF_LIFE')
  • If set to specific status: includes only models with that status

Example

// Only supported models (default behavior)
{ filterModelStatus: 'SUPPORTED' }

// All models regardless of status
{ filterModelStatus: '' }

// Only deprecated models
{ filterModelStatus: 'DEPRECATED' }

Optional maxTimeMS

maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The maxTimeMS option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using timeout, and defaults in timeoutDefaults. You may generally Ctrl+R replace maxTimeMS with timeout to retain the same behavior.

Optional timeout

timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "databaseAdminTimeoutMs">
Overview

Lets you specify timeouts for individual methods, in two different formats:

  • A subtype of TimeoutDescriptor, which lets you specify the timeout for specific categories.
  • A number, which specifies the "happy path" timeout for the method.
    • In single-call methods, this sets both the request & overall method timeouts.
    • In multi-call methods, this sets the overall method timeout (request timeouts are kept as default).

Example

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 1000ms.
await coll.insertOne({ ... }, { timeout: 1000 });

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertOne({ ... }, { timeout: { generalMethodTimeoutMs: 2000 } });

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 2000ms.
await coll.insertMany([...], {
  timeout: { requestTimeoutMs: 2000, generalMethodTimeoutMs: 2000 },
});

Example

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertMany([...], { timeout: 2000 });

// `requestTimeoutMs` is left as default, `generalMethodTimeoutMs` is set to 2000ms.
await coll.insertMany([...], { timeout: { generalMethodTimeoutMs: 2000 } });

// Both `requestTimeoutMs` and `generalMethodTimeoutMs` are set to 2000ms.
await coll.insertMany([...], {
  timeout: { requestTimeoutMs: 2000, generalMethodTimeoutMs: 2000 },
});

See TimeoutDescriptor for much more information.

See

TimeoutDescriptor

Settings

Member Visibility

Theme

On This Page

filterModelStatusmaxTimeMStimeout