Share via


Workflow Class

Definition

A class that represents a workflow that can be executed.

public class Workflow
type Workflow = class
Public Class Workflow
Inheritance
Workflow

Properties

Name Description
Description

Gets the optional description of what the workflow does.

Name

Gets the optional human-readable name of the workflow.

StartExecutorId

Gets the identifier of the starting executor of the workflow.

Methods

Name Description
DescribeProtocolAsync(CancellationToken)

Retrieves a ProtocolDescriptor defining how to interact with this workflow.

ReflectEdges()

Gets the collection of edges grouped by their source node identifier.

ReflectPorts()

Gets the collection of external request ports, keyed by their ID.

Extension Methods

Name Description
AsAgent(Workflow, String, String, String, CheckpointManager, IWorkflowExecutionEnvironment, Boolean)

Convert a workflow with the appropriate primary input type to an AIAgent.

BindAsExecutor(Workflow, String, ExecutorOptions)

Configures a sub-workflow executor for the specified workflow, using the provided identifier and options.

ConfigureSubWorkflow(Workflow, String, ExecutorOptions)
Obsolete.

Configures a sub-workflow executor for the specified workflow, using the provided identifier and options.

ToDotString(Workflow)

Export the workflow as a DOT format digraph string.

ToMermaidString(Workflow)

Converts the specified Workflow into a Mermaid.js diagram representation.

Applies to