Flow Class
Definition
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.
Flow data model
public sealed class Flow : Microsoft.SemanticKernel.Experimental.Orchestration.FlowSteptype Flow = class
inherit FlowStepPublic NotInheritable Class Flow
Inherits FlowStep- Inheritance
Remarks
Principles: 1. The model should be decoupled from execution status 2. The model is mutable to allow dynamic changes 3. The model doesn't enforce any execution order as long as the dependencies are satisfied
Constructors
| Flow(String, String) |
Initializes a new instance of the Flow class. |
Properties
| CompletionType |
CompletionType of the step (Inherited from FlowStep) |
| Goal |
Goal of the step (Inherited from FlowStep) |
| Name |
Friendly name and identifier of the flow |
| Passthrough |
Variables to be passed through on iterations of the step (Inherited from FlowStep) |
| Plugins |
Gets or sets the plugin available for the current step (Inherited from FlowStep) |
| Provides |
Variables to be provided by the step (Inherited from FlowStep) |
| 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. (Inherited from FlowStep) |
| Steps |
Steps of the flow |
| 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. (Inherited from FlowStep) |
Methods
| AddPassthrough(String[], Boolean) |
Register the arguments passed through by the step (Inherited from FlowStep) |
| AddProvides(String[]) |
Register the arguments provided by the step (Inherited from FlowStep) |
| AddRequires(String[]) |
Register the required arguments for the step (Inherited from FlowStep) |
| AddStep(FlowStep) |
Adds a step to the flow |
| AddSteps(FlowStep[]) |
Adds steps to the flow |
| DependsOn(FlowStep) |
Check if the step depends on another step (Inherited from FlowStep) |
| LoadPlugins(Kernel, Dictionary<Object,String>) |
Get the plugin instances registered with the step (Inherited from FlowStep) |
Extension Methods
| BuildReferenceAsync(Flow, IFlowCatalog) |
Hydrate the reference steps in the flow. |