FunctionResult Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the result of a KernelFunction invocation.

public sealed class FunctionResult

type FunctionResult = class

Public NotInheritable Class FunctionResult

Inheritance: Object
FunctionResult

Constructors

FunctionResult(FunctionResult, Object)	Initializes a new instance of the FunctionResult class.
FunctionResult(KernelFunction, Object, CultureInfo, IReadOnlyDictionary<String,Object>)	Initializes a new instance of the FunctionResult class.

Properties

Culture	The culture configured on the Kernel that executed the function.
Function	Gets the KernelFunction whose result is represented by this instance.
Metadata	Gets any metadata associated with the function's execution.
RenderedPrompt	Gets the prompt used during function invocation if any was rendered.
ValueType	Gets the Type of the function's result.

Methods

GetValue<T>()	Returns function result value.
ToString()	Returns a string that represents the current object.

Extension Methods

GetChatHistory(FunctionResult)	Get ChatHistory from context.
GetChatInput(FunctionResult)	Get latest chat input from context.
IsComplete(FunctionResult, Flow)	Check if all arguments to be provided with the flow is available in the context
IsTerminateFlow(FunctionResult)	Check if we should terminate flow based on function result.

Applies to

Share via