Class KernelFunction<ReturnType, Schema, Args>`Abstract`

Type Parameters

ReturnType = unknown
Schema extends JsonSchema = typeof DefaultJsonSchema
Args = FromSchema<Schema>

Hierarchy (View Summary)

KernelFunction
- KernelFunctionFromPrompt

Index

Constructors

constructor

new KernelFunction<
    ReturnType = unknown,
    Schema extends JsonSchema = {},
    Args = FromSchema<Schema>,
>(
    metadata: KernelFunctionMetadata<Schema>,
): KernelFunction<ReturnType, Schema, Args>
Type Parameters
- ReturnType = unknown
- Schema extends JsonSchema = {}
- Args = FromSchema<Schema>
Parameters
- metadata: KernelFunctionMetadata<Schema>
Returns KernelFunction<ReturnType, Schema, Args>
- Defined in src/abstractions/dist/index.d.ts:102

Accessors

executionSettings

get executionSettings(): undefined | Map<string, PromptExecutionSettings>
Returns undefined | Map<string, PromptExecutionSettings>
- Defined in src/abstractions/dist/index.d.ts:105
set executionSettings(
    settings:
        | PromptExecutionSettings
        | Map<string, PromptExecutionSettings>
        | PromptExecutionSettings[],
): void
Parameters
- settings:
      | PromptExecutionSettings
      | Map<string, PromptExecutionSettings>
      | PromptExecutionSettings[]
Returns void
- Defined in src/abstractions/dist/index.d.ts:106

metadata

get metadata(): KernelFunctionMetadata<Schema>
Returns KernelFunctionMetadata<Schema>
- Defined in src/abstractions/dist/index.d.ts:103
set metadata(metadata: KernelFunctionMetadata<Schema>): void
Parameters
- metadata: KernelFunctionMetadata<Schema>
Returns void
- Defined in src/abstractions/dist/index.d.ts:104

Methods

asAIFunction

asAIFunction(kernel: Kernel): AIFunction<undefined | ReturnType, Schema, Args>
Parameters
- kernel: Kernel
Returns AIFunction<undefined | ReturnType, Schema, Args>
- Defined in src/abstractions/dist/index.d.ts:111

invoke

invoke(
kernel: Kernel,
args?: KernelArguments<Schema, Args>,
): Promise<FunctionResult<ReturnType, Schema, Args>>
Parameters
- kernel: Kernel
- Optionalargs: KernelArguments<Schema, Args>
Returns Promise<FunctionResult<ReturnType, Schema, Args>>
- Defined in src/abstractions/dist/index.d.ts:109

`Protected` `Abstract`invokeCore

invokeCore(
kernel: Kernel,
args: KernelArguments<Schema, Args>,
): Promise<FunctionResult<ReturnType, Schema, Args>>
Parameters
- kernel: Kernel
- args: KernelArguments<Schema, Args>
Returns Promise<FunctionResult<ReturnType, Schema, Args>>
- Defined in src/abstractions/dist/index.d.ts:107

invokeStreaming

invokeStreaming<T>(
kernel: Kernel,
args?: KernelArguments<Schema, Args>,
): AsyncGenerator<T>
Type Parameters
- T
Parameters
- kernel: Kernel
- Optionalargs: KernelArguments<Schema, Args>
Returns AsyncGenerator<T>
- Defined in src/abstractions/dist/index.d.ts:110

`Protected` `Abstract`invokeStreamingCore

invokeStreamingCore<T>(
kernel: Kernel,
args: KernelArguments<Schema, Args>,
): AsyncGenerator<T>
Type Parameters
- T
Parameters
- kernel: Kernel
- args: KernelArguments<Schema, Args>
Returns AsyncGenerator<T>
- Defined in src/abstractions/dist/index.d.ts:108

Class KernelFunction<ReturnType, Schema, Args>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns KernelFunction<ReturnType, Schema, Args>

Accessors

executionSettings

Returns undefined | Map<string, PromptExecutionSettings>

Parameters

Returns void

metadata

Returns KernelFunctionMetadata<Schema>

Parameters

Returns void

Methods

asAIFunction

Parameters

Returns AIFunction<undefined | ReturnType, Schema, Args>

invoke

Parameters

Returns Promise<FunctionResult<ReturnType, Schema, Args>>

Protected AbstractinvokeCore

Parameters

Returns Promise<FunctionResult<ReturnType, Schema, Args>>

invokeStreaming

Type Parameters

Parameters

Returns AsyncGenerator<T>

Protected AbstractinvokeStreamingCore

Type Parameters

Parameters

Returns AsyncGenerator<T>

Settings

On This Page

Class KernelFunction<ReturnType, Schema, Args>`Abstract`

`Protected` `Abstract`invokeCore

`Protected` `Abstract`invokeStreamingCore