OrchestrationBuilderBase<TBuilder> Class

Definition

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

Common fluent surface shared by every orchestration-style workflow builder: human-readable name + description, and the WithOutputFrom(IEnumerable<AIAgent>) / WithIntermediateOutputFrom(IEnumerable<AIAgent>) output-designation pair with memoized defaults-suppression semantics.

public abstract class OrchestrationBuilderBase<TBuilder> where TBuilder : OrchestrationBuilderBase<TBuilder>
type OrchestrationBuilderBase<'Builder (requires 'Builder :> OrchestrationBuilderBase<'Builder>)> = class
Public MustInherit Class OrchestrationBuilderBase(Of TBuilder)

Type Parameters

TBuilder

The concrete builder type, for fluent self-return.

Inheritance
Object
OrchestrationBuilderBase<TBuilder>
Derived

Constructors

Name Description
OrchestrationBuilderBase<TBuilder>()

Properties

Name Description
Description

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

Optional workflow name; applied to the inner WorkflowBuilder at Build().
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.

Methods

Name Description
ApplyMetadata(WorkflowBuilder)

Applies the optional Name and Description to builder. Subclasses should call this from their Build() implementation.
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.
WithDescription(String)

Sets the description for the workflow.
WithIntermediateOutputFrom(IEnumerable<AIAgent>)

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

Sets the human-readable name for the workflow.
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.

Applies to