Interface IOptions

The session initialization options.

interface IOptions {
    clientId?: string;
    kernelConnectionOptions?: Omit<
        Kernel.IKernelConnection.IOptions,
        "username"
        | "serverSettings"
        | "model"
        | "clientId",
    >;
    model: Session.IModel;
    serverSettings?: ServerConnection.ISettings;
    sessionAPIClient?: ISessionAPIClient;
    username?: string;
    connectToKernel(
        options: Kernel.IKernelConnection.IOptions,
    ): Kernel.IKernelConnection;
}

Index

Properties

clientId? kernelConnectionOptions? model serverSettings? sessionAPIClient? username?

Methods

connectToKernel

Properties

`Optional`clientId

clientId?: string

The unique identifier for the session client.

`Optional`kernelConnectionOptions

kernelConnectionOptions?: Omit<
    Kernel.IKernelConnection.IOptions,
    "username"
    | "serverSettings"
    | "model"
    | "clientId",
>

Kernel connection options

model

model: Session.IModel

Session model.

`Optional`serverSettings

serverSettings?: ServerConnection.ISettings

The server settings.

`Optional`sessionAPIClient

sessionAPIClient?: ISessionAPIClient

The session API client.

`Optional`username

username?: string

The username of the session client.

Methods

connectToKernel

connectToKernel(
options: Kernel.IKernelConnection.IOptions,
): Kernel.IKernelConnection
Connects to an existing kernel
Parameters
- options: Kernel.IKernelConnection.IOptions
Returns Kernel.IKernelConnection
- Defined in packages/services/src/session/session.ts:201