Skip to main content

Interface: ProviderDescriptor

Defined in: packages/core/src/providers/catalog.ts:86

Properties​

baseUrlEnv?​

readonly optional baseUrlEnv?: string

Defined in: packages/core/src/providers/catalog.ts:98

Env var a base-URL override is read from, when the provider has one.


capabilities​

readonly capabilities: ProviderCapabilities

Defined in: packages/core/src/providers/catalog.ts:119


defaultBaseUrl​

readonly defaultBaseUrl: string

Defined in: packages/core/src/providers/catalog.ts:106

The provider's official endpoint.


defaultKeyHosts?​

readonly optional defaultKeyHosts?: readonly string[]

Defined in: packages/core/src/providers/catalog.ts:104

The hosts (and their subdomains) a default key — from envKeys or setDefaultApiKey — is sent to once a base URL is set. Absent means any host. A key the caller gives in config is always sent.


defaultModel​

readonly defaultModel: string

Defined in: packages/core/src/providers/catalog.ts:112

The model a host picks for this provider when the user names none.


envKeys​

readonly envKeys: readonly string[]

Defined in: packages/core/src/providers/catalog.ts:96

Env vars the API key is read from, in order; the first non-empty one wins.


idPrefixes​

readonly idPrefixes: readonly string[]

Defined in: packages/core/src/providers/catalog.ts:118

Model-id prefixes only this provider's own models use, so a bare id starting with one routes here. Open model families (llama, qwen) are never listed: several providers serve them.


keyless​

readonly keyless: boolean

Defined in: packages/core/src/providers/catalog.ts:108

Serves without an API key (a key, when set, is still sent).


listable​

readonly listable: boolean

Defined in: packages/core/src/providers/catalog.ts:110

listModels can read this provider's catalog.


load​

readonly load: () => Promise<ModelFactory>

Defined in: packages/core/src/providers/catalog.ts:94

Imports package and returns the factory built on it. Called once per process through the model resolver, which names the package when the import fails.

Returns​

Promise<ModelFactory>


package​

readonly package: string

Defined in: packages/core/src/providers/catalog.ts:88

The npm package the AI SDK provider comes from.