GroupChatWorkflowBuilder Class

Definition

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

Provides a builder for specifying group chat relationships between agents and building the resulting workflow.

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

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
AddParticipants(IEnumerable<AIAgent>)

Adds the specified agents as participants to the group chat workflow.
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 a Workflow composed of agents that operate via group chat, with the next agent to process messages selected by the group chat manager.
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