FlowStep Class

Definition

Namespace:

Microsoft.SemanticKernel.Experimental.Orchestration

Assembly:

Microsoft.SemanticKernel.Experimental.Orchestration.Flow.dll

Package:

Microsoft.SemanticKernel.Experimental.Orchestration.Flow v1.20.0-alpha

Step within a Flow which defines the step goal, available plugins, required and provided variables.

public class FlowStep

type FlowStep = class

Public Class FlowStep

Inheritance

Object

FlowStep

Derived

Microsoft.SemanticKernel.Experimental.Orchestration.Flow

Microsoft.SemanticKernel.Experimental.Orchestration.ReferenceFlowStep

Constructors

FlowStep(String, Func<Kernel,Dictionary<Object,String>,IEnumerable<Object>>)

Initializes a new instance of the FlowStep class.

Properties

CompletionType	CompletionType of the step
Goal	Goal of the step
Passthrough	Variables to be passed through on iterations of the step
Plugins	Gets or sets the plugin available for the current step
Provides	Variables to be provided by the step
Requires	Parameters required for executing the step
StartingMessage	If the CompletionType is CompletionType.ZeroOrMore, this message will be used to ask the user if they want to execute the current step or skip it.
TransitionMessage	If the CompletionType is CompletionType.AtLeastOnce or CompletionType.ZeroOrMore, this message will be used to ask the user if they want to try the step again.

Methods

AddPassthrough(String[], Boolean)	Register the arguments passed through by the step
AddProvides(String[])	Register the arguments provided by the step
AddRequires(String[])	Register the required arguments for the step
DependsOn(FlowStep)	Check if the step depends on another step
LoadPlugins(Kernel, Dictionary<Object,String>)	Get the plugin instances registered with the step