Share via


AutoFunctionInvocationContext Class

Definition

Class with data related to automatic function invocation.

public class AutoFunctionInvocationContext
type AutoFunctionInvocationContext = class
Public Class AutoFunctionInvocationContext
Inheritance
AutoFunctionInvocationContext

Constructors

AutoFunctionInvocationContext(Kernel, KernelFunction, FunctionResult, ChatHistory, ChatMessageContent)

Initializes a new instance of the AutoFunctionInvocationContext class.

Properties

Arguments

Gets the arguments associated with the operation.

CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

ChatHistory

Gets the ChatHistory associated with automatic function invocation.

ChatMessageContent

The chat message content associated with automatic function invocation.

Function

Gets the KernelFunction with which this filter is associated.

FunctionCount

Number of functions that will be invoked during auto function invocation request.

FunctionSequenceIndex

Function sequence index. Starts from 0.

Kernel

Gets the Kernel containing services, plugins, and other state for use throughout the operation.

RequestSequenceIndex

Request sequence index of automatic function invocation process. Starts from 0.

Result

Gets or sets the result of the function's invocation.

Terminate

Gets or sets a value indicating whether the operation associated with the filter should be terminated. By default it's false, in this case all functions will be executed. As soon as it's set to true, the remaining functions won't be executed and last request to LLM won't be performed. Automatic function invocation process will be terminated and result of last executed function will be returned to the caller.

ToolCallId

The ID of the tool call.

Applies to