Class Kernel

Represents a kernel.

Index

Constructors

constructor

new Kernel(): Kernel
Creates a new kernel.

Returns Kernel
- Defined in src/abstractions/dist/index.d.ts:200

Accessors

plugins

get plugins(): KernelPlugins
Gets the KernelPlugins instance.

Returns KernelPlugins
- Defined in src/abstractions/dist/index.d.ts:204

services

get services(): ServiceProvider
Gets the ServiceProvider instance.

Returns ServiceProvider
- Defined in src/abstractions/dist/index.d.ts:208

Methods

addPlugin

addPlugin(plugin: ArrayKernelPlugin): this
Adds a plugin to the kernel.
Parameters
- plugin: ArrayKernelPlugin
  The plugin to add.
Returns this
The kernel.
- Defined in src/abstractions/dist/index.d.ts:220

addService

addService(...props: [service: unknown, options?: { serviceId: string }]): this
Adds a service to the kernel.
Parameters
- ...props: [service: unknown, options?: { serviceId: string }]
Returns this
The kernel.
- Defined in src/abstractions/dist/index.d.ts:214

invoke

invoke<
    ReturnType = unknown,
    Schema extends JsonSchema = {},
    Args = FromSchema<Schema>,
>(
    params: {
        args?: KernelArguments<Schema, Args>;
        executionSettings?:
            | PromptExecutionSettings
            | Map<string, PromptExecutionSettings>
            | PromptExecutionSettings[];
        kernelFunction: KernelFunction<ReturnType, Schema, Args>;
    },
): Promise<undefined | ReturnType>
Invokes a KernelFunction.
Type Parameters
- ReturnType = unknown
- Schema extends JsonSchema = {}
- Args = FromSchema<Schema>
Parameters
- params: {
      args?: KernelArguments<Schema, Args>;
      executionSettings?:
          | PromptExecutionSettings
          | Map<string, PromptExecutionSettings>
          | PromptExecutionSettings[];
      kernelFunction: KernelFunction<ReturnType, Schema, Args>;
  }
  The parameters for the kernel function.
  - Optionalargs?: KernelArguments<Schema, Args>
    The arguments to pass to the kernel function (optional).
  - OptionalexecutionSettings?:
        | PromptExecutionSettings
        | Map<string, PromptExecutionSettings>
        | PromptExecutionSettings[]
    The execution settings to pass to the kernel function (optional).
  - kernelFunction: KernelFunction<ReturnType, Schema, Args>
    The kernel function to invoke.
Returns Promise<undefined | ReturnType>
The result of the KernelFunction.
- Defined in src/abstractions/dist/index.d.ts:229

invokePrompt

invokePrompt(
    prompt: string,
    params?: Omit<
        Partial<KernelFunctionFromPromptMetadata>,
        "executionSettings",
    > & {
        args?: KernelArguments<{}, unknown>;
        executionSettings?:
            | PromptExecutionSettings
            | Map<string, PromptExecutionSettings>
            | PromptExecutionSettings[];
    },
): Promise<undefined | ChatResponse>
Invokes a prompt.
Parameters
- prompt: string
  Prompt to invoke.
- Optionalparams: Omit<Partial<KernelFunctionFromPromptMetadata>, "executionSettings"> & {
      args?: KernelArguments<{}, unknown>;
      executionSettings?:
          | PromptExecutionSettings
          | Map<string, PromptExecutionSettings>
          | PromptExecutionSettings[];
  }
  The parameters for the prompt.
Returns Promise<undefined | ChatResponse>
The result of the prompt invocation.
- Defined in src/abstractions/dist/index.d.ts:245

invokeStreaming

invokeStreaming<
    T,
    ReturnType = unknown,
    Schema extends JsonSchema = {},
    Args = FromSchema<Schema>,
>(
    __namedParameters: {
        args?: KernelArguments<Schema, Args>;
        executionSettings?:
            | PromptExecutionSettings
            | Map<string, PromptExecutionSettings>
            | PromptExecutionSettings[];
        kernelFunction: KernelFunction<ReturnType, Schema, Args>;
    },
): AsyncGenerator<T, any, unknown>
Type Parameters
- T
- ReturnType = unknown
- Schema extends JsonSchema = {}
- Args = FromSchema<Schema>
Parameters
- __namedParameters: {
      args?: KernelArguments<Schema, Args>;
      executionSettings?:
          | PromptExecutionSettings
          | Map<string, PromptExecutionSettings>
          | PromptExecutionSettings[];
      kernelFunction: KernelFunction<ReturnType, Schema, Args>;
  }
Returns AsyncGenerator<T, any, unknown>
- Defined in src/abstractions/dist/index.d.ts:234

invokeStreamingPrompt

invokeStreamingPrompt(
    prompt: string,
    params?: Omit<
        Partial<KernelFunctionFromPromptMetadata>,
        "executionSettings",
    > & {
        args?: KernelArguments<{}, unknown>;
        executionSettings?:
            | PromptExecutionSettings
            | Map<string, PromptExecutionSettings>
            | PromptExecutionSettings[];
    },
): AsyncGenerator<ChatResponseUpdate, any, unknown>
Invokes a streaming prompt.
Parameters
- prompt: string
  Prompt to invoke.
- Optionalparams: Omit<Partial<KernelFunctionFromPromptMetadata>, "executionSettings"> & {
      args?: KernelArguments<{}, unknown>;
      executionSettings?:
          | PromptExecutionSettings
          | Map<string, PromptExecutionSettings>
          | PromptExecutionSettings[];
  }
  The parameters for the prompt.
Returns AsyncGenerator<ChatResponseUpdate, any, unknown>
A stream of ChatResponseUpdate objects.
- Defined in src/abstractions/dist/index.d.ts:255

Class Kernel

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Kernel

Accessors

plugins

Returns KernelPlugins

services

Returns ServiceProvider

Methods

addPlugin

Parameters

Returns this

addService

Parameters

Returns this

invoke

Type Parameters

Parameters

`Optional`args?: KernelArguments<Schema, Args>

`Optional`executionSettings?:
    | PromptExecutionSettings
    | Map<string, PromptExecutionSettings>
    | PromptExecutionSettings[]

kernelFunction: KernelFunction<ReturnType, Schema, Args>

Returns Promise<undefined | ReturnType>

invokePrompt

Parameters

Returns Promise<undefined | ChatResponse>

invokeStreaming

Type Parameters

Parameters

Returns AsyncGenerator<T, any, unknown>

invokeStreamingPrompt

Parameters

Returns AsyncGenerator<ChatResponseUpdate, any, unknown>

Settings

On This Page

Class Kernel

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Kernel

Accessors

plugins

Returns KernelPlugins

services

Returns ServiceProvider

Methods

addPlugin

Parameters

Returns this

addService

Parameters

Returns this

invoke

Type Parameters

Parameters

Optionalargs?: KernelArguments<Schema, Args>

OptionalexecutionSettings?: | PromptExecutionSettings | Map<string, PromptExecutionSettings> | PromptExecutionSettings[]

kernelFunction: KernelFunction<ReturnType, Schema, Args>

Returns Promise<undefined | ReturnType>

invokePrompt

Parameters

Returns Promise<undefined | ChatResponse>

invokeStreaming

Type Parameters

Parameters

Returns AsyncGenerator<T, any, unknown>

invokeStreamingPrompt

Parameters

Returns AsyncGenerator<ChatResponseUpdate, any, unknown>

Settings

On This Page

`Optional`args?: KernelArguments<Schema, Args>

`Optional`executionSettings?:
| PromptExecutionSettings
| Map<string, PromptExecutionSettings>
| PromptExecutionSettings[]