Interface LmProviderParams

Parameters required when creating a new LM provider instance.

LmProviderParams

interface LmProviderParams {
    apiKey?: string;
    defaults?: LmDefaults;
    name: string;
    onEndEmit?: ((result) => void);
    onError?: ((err) => void);
    onStartEmit?: ((data) => void);
    onToken?: ((t) => void);
    serverUrl: string;
}

Properties

apiKey? defaults? name onEndEmit? onError? onStartEmit? onToken? serverUrl

Properties

Optional apiKey

apiKey?: string

The key used for authentication.

Optional defaults

defaults?: LmDefaults

Default settings.

name

name: string

Identifier for the LM provider.

Optional onEndEmit

onEndEmit?: ((result) => void)

Callback triggered when inference ends.

Type declaration

Optional onError

onError?: ((err) => void)

Callback triggered on errors.

Type declaration

    • (err): void

    • Parameters

      • err: string

      Returns void

Optional onStartEmit

onStartEmit?: ((data) => void)

Callback triggered when inference starts.

Type declaration

Optional onToken

onToken?: ((t) => void)

Callback when a new token is received.

Type declaration

    • (t): void

    • Parameters

      • t: string

      Returns void

serverUrl

serverUrl: string

The URL endpoint for the provider's server.

Settings

Member Visibility

Theme

On This Page

apiKeydefaultsnameonEndEmitonErroronStartEmitonTokenserverUrl