Interface RerankingProviderInfo

Info about a specific reranking provider

Field

displayName - The prettified name of the provider (as shown in the portal)

Field

isDefault - Whether this provider is the default for reranking

Field

supportedAuthentication - Enabled methods of auth for the provider

Field

models - The specific models that the provider supports

See

FindRerankingProvidersResult

interface RerankingProviderInfo {
    displayName: string;
    isDefault: boolean;
    models: RerankingProviderModelInfo[];
    parameters?: Record<string, unknown>;
    supportedAuthentication: Record<LitUnion<"HEADER" | "SHARED_SECRET" | "NONE">, RerankingProviderAuthInfo>;
}

Properties

displayName: string

The prettified name of the provider (as shown in the Astra portal).

Example

// nvidia.displayName:
'Nvidia'
isDefault: boolean

Whether this provider is the default for reranking.

Example

// nvidia.isDefault:
true

The specific models that the provider supports.

Example

// nvidia.models[0]
{
name: 'nvidia/llama-3.2-nv-rerankqa-1b-v2',
isDefault: true,
url: 'https://...',
properties: null,
apiModelSupport: {
status: 'SUPPORTED',
},
}
parameters?: Record<string, unknown>

Additional parameters for the provider, if any.

supportedAuthentication: Record<LitUnion<"HEADER" | "SHARED_SECRET" | "NONE">, RerankingProviderAuthInfo>

Supported methods of authentication for the provider.

Possible methods include 'HEADER', 'SHARED_SECRET', and 'NONE'.

  • 'HEADER': Authentication using direct API keys passed through headers on every Data API call.
  • 'SHARED_SECRET': Authentication tied to a collection at collections creation time using the Astra KMS.
  • 'NONE': For when a client doesn't need authentication to use (e.g. nvidia).

Example

// nvidia.supportedAuthentication.NONE:
{
enabled: true,
tokens: [],
}