Class KernelFunctionFromPrompt

Hierarchy (View Summary)

KernelFunction<ChatResponse>
- KernelFunctionFromPrompt

Index

Accessors

executionSettings metadata

Methods

asAIFunction invoke invokeCore invokeStreaming invokeStreamingCore create

Accessors

executionSettings

get executionSettings(): undefined | Map<string, PromptExecutionSettings>
Returns undefined | Map<string, PromptExecutionSettings>
Inherited from KernelFunction.executionSettings
- 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
Inherited from KernelFunction.executionSettings
- Defined in src/abstractions/dist/index.d.ts:106

metadata

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

Methods

asAIFunction

asAIFunction(kernel: Kernel): AIFunction<undefined | ChatResponse, {}, unknown>
Parameters
- kernel: Kernel
Returns AIFunction<undefined | ChatResponse, {}, unknown>
Inherited from KernelFunction.asAIFunction
- Defined in src/abstractions/dist/index.d.ts:111

invoke

invoke(
kernel: Kernel,
args?: KernelArguments<{}, unknown>,
): Promise<FunctionResult<ChatResponse, {}, unknown>>
Parameters
- kernel: Kernel
- Optionalargs: KernelArguments<{}, unknown>
Returns Promise<FunctionResult<ChatResponse, {}, unknown>>
Inherited from KernelFunction.invoke
- Defined in src/abstractions/dist/index.d.ts:109

invokeCore

invokeCore(
kernel: Kernel,
args: KernelArguments,
): Promise<FunctionResult<ChatResponse, {}, unknown>>
Parameters
- kernel: Kernel
- args: KernelArguments
Returns Promise<FunctionResult<ChatResponse, {}, unknown>>
Overrides KernelFunction.invokeCore
- Defined in src/abstractions/dist/index.d.ts:142

invokeStreaming

invokeStreaming<T>(
kernel: Kernel,
args?: KernelArguments<{}, unknown>,
): AsyncGenerator<T>
Type Parameters
- T
Parameters
- kernel: Kernel
- Optionalargs: KernelArguments<{}, unknown>
Returns AsyncGenerator<T>
Inherited from KernelFunction.invokeStreaming
- Defined in src/abstractions/dist/index.d.ts:110

invokeStreamingCore

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

`Static`create

create(
prompt: string,
params: Partial<KernelFunctionFromPromptMetadata>,
): KernelFunctionFromPrompt
Creates a new kernel function from a prompt.
Parameters
- prompt: string
  The prompt to create the kernel function from.
- params: Partial<KernelFunctionFromPromptMetadata>
  The parameters to create the kernel function from a prompt.
Returns KernelFunctionFromPrompt
A new kernel function from a prompt.
- Defined in src/abstractions/dist/index.d.ts:141

Class KernelFunctionFromPrompt

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

executionSettings

Returns undefined | Map<string, PromptExecutionSettings>

Parameters

Returns void

metadata

Returns KernelFunctionMetadata<Schema>

Parameters

Returns void

Methods

asAIFunction

Parameters

Returns AIFunction<undefined | ChatResponse, {}, unknown>

invoke

Parameters

Returns Promise<FunctionResult<ChatResponse, {}, unknown>>

invokeCore

Parameters

Returns Promise<FunctionResult<ChatResponse, {}, unknown>>

invokeStreaming

Type Parameters

Parameters

Returns AsyncGenerator<T>

invokeStreamingCore

Type Parameters

Parameters

Returns AsyncGenerator<T>

Staticcreate

Parameters

Returns KernelFunctionFromPrompt

Settings

On This Page

`Static`create