Interface LmParams

Parameters for initializing a Language Model.

LmParams

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

Properties

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

Properties

Optional apiKey

apiKey?: string

Optional API key for authentication.

Optional defaults

defaults?: LmDefaults

Default settings.

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

providerType

providerType: LmProviderType

Type of provider ("koboldcpp", "ollama", "goinfer").

serverUrl

serverUrl: string

The URL endpoint for the LM service.

Settings

Member Visibility

Theme

On This Page

apiKeydefaultsonEndEmitonErroronStartEmitonTokenproviderTypeserverUrl