FunctionChoice Struct

Definition

Namespace:

Microsoft.SemanticKernel

Assembly:

Microsoft.SemanticKernel.Abstractions.dll

Package:

Microsoft.SemanticKernel.Abstractions v1.20.0

Represents an AI model's decision-making strategy for calling functions, offering predefined choices: Auto, Required, and None. Auto allows the model to decide if and which functions to call, Required enforces calling one or more functions, and None prevents any function calls, generating only a user-facing message.

public readonly struct FunctionChoice : IEquatable<Microsoft.SemanticKernel.FunctionChoice>

type FunctionChoice = struct

Public Structure FunctionChoice
Implements IEquatable(Of FunctionChoice)

Inheritance

ValueType

FunctionChoice

Implements

IEquatable<FunctionChoice>

Constructors

FunctionChoice(String)

Creates a new FunctionChoice instance with the provided label.

Properties

Auto	This choice instructs the model to decide whether to call the functions or not and, if so, which ones to call.
Label	Gets the label associated with this FunctionChoice.
None	This behavior forces the model to not call any functions and only generate a user-facing message.
Required	This choice forces the model to always call one or more functions. The model will then select which function(s) to call.

Methods

Equals(FunctionChoice)	Indicates whether the current object is equal to another object of the same type.
Equals(Object)	Indicates whether this instance and a specified object are equal.
GetHashCode()	Returns the hash code for this instance.
ToString()	Returns the fully qualified type name of this instance.

Operators

Equality(FunctionChoice, FunctionChoice)	Returns a value indicating whether two FunctionChoice instances are equivalent, as determined by a case-insensitive comparison of their labels.
Inequality(FunctionChoice, FunctionChoice)	Returns a value indicating whether two FunctionChoice instances are not equivalent, as determined by a case-insensitive comparison of their labels.