SequentialWorkflowBuilder Class

Definition

Namespace:
Microsoft.Agents.AI.Workflows
Assembly:
Microsoft.Agents.AI.Workflows.dll
Package:
Microsoft.Agents.AI.Workflows v1.13.0

Fluent builder for sequential agent workflows: a pipeline where the output of one agent is the input to the next, terminating in an aggregator that yields the accumulated ChatMessages as the workflow output.

public sealed class SequentialWorkflowBuilder : Microsoft.Agents.AI.Workflows.OrchestrationBuilderBase<Microsoft.Agents.AI.Workflows.SequentialWorkflowBuilder>
type SequentialWorkflowBuilder = class
    inherit OrchestrationBuilderBase<SequentialWorkflowBuilder>
Public NotInheritable Class SequentialWorkflowBuilder
Inherits OrchestrationBuilderBase(Of SequentialWorkflowBuilder)
Inheritance
Object
OrchestrationBuilderBase<SequentialWorkflowBuilder>
SequentialWorkflowBuilder

Remarks

When no explicit output designations are made, the default is the Python-aligned shape: the terminal aggregator is the workflow output, and every participating agent is designated as an intermediate output source. Calling WithOutputFrom(IEnumerable<AIAgent>) or WithIntermediateOutputFrom(IEnumerable<AIAgent>) at all suppresses these defaults.

Constructors

Name Description
SequentialWorkflowBuilder(IEnumerable<AIAgent>)

Initializes a new SequentialWorkflowBuilder with the given pipeline of agents.

Properties

Name Description
Description

Optional workflow description; applied to the inner WorkflowBuilder at Build().

(Inherited from OrchestrationBuilderBase<TBuilder>)
Name

Optional workflow name; applied to the inner WorkflowBuilder at Build().

(Inherited from OrchestrationBuilderBase<TBuilder>)
OutputDesignations

Memoized output designations. null means the user has not made any explicit designation, and the orchestration-specific defaults will be applied at Build() time. A non-null (possibly empty) map means the user took control and only these designations will be replayed onto the inner WorkflowBuilder. An entry's value is the set of tags requested for the agent — an empty set encodes a terminal-only designation.

(Inherited from OrchestrationBuilderBase<TBuilder>)

Methods

Name Description
ApplyMetadata(WorkflowBuilder)

Applies the optional Name and Description to builder. Subclasses should call this from their Build() implementation.

(Inherited from OrchestrationBuilderBase<TBuilder>)
ApplyOutputDesignations(WorkflowBuilder, IReadOnlyDictionary<AIAgent,ExecutorBinding>, String, Action)

Applies the user's memoized output designations to builder, or invokes applyDefaults if the user made no explicit designation.

(Inherited from OrchestrationBuilderBase<TBuilder>)
Build()

Builds the configured sequential workflow.
WithChainOnlyAgentResponses(Boolean)

Configures whether each downstream agent should receive only the previous agent's output, instead of the full accumulated conversation.
WithDescription(String)

Sets the description for the workflow.

(Inherited from OrchestrationBuilderBase<TBuilder>)
WithIntermediateOutputFrom(IEnumerable<AIAgent>)

Designates the given agents as sources of intermediate workflow output. See WithOutputFrom(IEnumerable<AIAgent>) for the defaults-suppression semantics.

(Inherited from OrchestrationBuilderBase<TBuilder>)
WithName(String)

Sets the human-readable name for the workflow.

(Inherited from OrchestrationBuilderBase<TBuilder>)
WithOutputFrom(IEnumerable<AIAgent>)

Designates the given agents as sources of terminal workflow output. Calling any output-designation method (this or WithIntermediateOutputFrom(IEnumerable<AIAgent>)) suppresses the orchestration-specific defaults: only the user-specified designations reach the inner WorkflowBuilder.

(Inherited from OrchestrationBuilderBase<TBuilder>)

Applies to