Struct GroupChatBuilder 

pub struct GroupChatBuilder { /* private fields */ }

Builder for a group chat workflow. Rust analogue of GroupChatBuilder.

let workflow = GroupChatBuilder::new()
    .participant("writer", writer)
    .participant("reviewer", reviewer)
    .round_robin()
    .max_rounds(4)
    .build()?;

Implementations

impl GroupChatBuilder

pub fn new() -> GroupChatBuilder

Create an empty builder (round-robin manager by default).

pub fn participant( self, name: impl Into<String>, agent: Arc<dyn SupportsAgentRun>, ) -> GroupChatBuilder

Register a participant (its description defaults to its name).

pub fn participant_described( self, name: impl Into<String>, description: impl Into<String>, agent: Arc<dyn SupportsAgentRun>, ) -> GroupChatBuilder

Register a participant with an explicit description (shown to an LLM manager for selection).

pub fn participants( self, participants: impl IntoIterator<Item = (String, Arc<dyn SupportsAgentRun>)>, ) -> GroupChatBuilder

Register several participants as (name, agent) pairs.

pub fn round_robin(self) -> GroupChatBuilder

Use the built-in round-robin manager (the default).

pub fn manager(self, manager: Arc<dyn GroupChatManager>) -> GroupChatBuilder

Use a custom GroupChatManager.

pub fn manager_fn<F>(self, f: F) -> GroupChatBuilder

where F: Fn(&GroupChatState) -> GroupChatDirective + Send + Sync + 'static,

Use a custom synchronous closure to select the next speaker or finish.

pub fn manager_agent(self, agent: Arc<dyn SupportsAgentRun>) -> GroupChatBuilder

Use an LLM agent as the manager (prompted with DEFAULT_MANAGER_INSTRUCTIONS and asked for a ManagerSelectionResponse as JSON).

pub fn max_rounds(self, max_rounds: usize) -> GroupChatBuilder

Cap the number of manager rounds. When unset, the builder applies DEFAULT_GROUP_CHAT_MAX_ITERATIONS.

pub fn termination_condition<F>(self, condition: F) -> GroupChatBuilder

where F: Fn(&[Message]) -> bool + Send + Sync + 'static,

Set a termination condition evaluated against the running conversation before each manager turn.

pub fn manager_name(self, name: impl Into<String>) -> GroupChatBuilder

Override the manager’s display name (used to attribute its messages).

pub fn name(self, name: impl Into<String>) -> GroupChatBuilder

Set the workflow name.

pub fn output_from( self, names: impl IntoIterator<Item = impl Into<String>>, ) -> GroupChatBuilder

Designate participants (by the name passed to Self::participant/Self::participant_described) as a workflow output source, forwarded to WorkflowBuilder::output_from.

Divergence from Sequential/Concurrent: unlike those builders, a group chat compiles to a single orchestrator Executor that runs the whole manager/participant loop internally (see the module-level design note) rather than one executor per participant, so there is no per-participant executor id to route to individually. Naming any participant here is therefore equivalent to naming every participant: it simply keeps the orchestrator’s single final yield — the finished conversation — as the terminal WorkflowEvent::Output (already the default when no designation is set at all). Its practical purpose is composing a group chat into a larger workflow: call Self::intermediate_output_from instead to demote the group chat’s result to a non-terminal WorkflowEvent::Intermediate event, e.g. when this workflow feeds a downstream stage.

Rejected at build() if a name does not match any registered participant, or if this and Self::intermediate_output_from are both non-empty (both resolve to the same underlying executor id, so the id would be designated as both terminal and non-terminal).

pub fn intermediate_output_from( self, names: impl IntoIterator<Item = impl Into<String>>, ) -> GroupChatBuilder

Designate participants (by name) as an intermediate-output source, demoting the group chat orchestrator’s single final yield to a non-terminal WorkflowEvent::Intermediate event instead of the workflow’s terminal output. See Self::output_from for the single-executor caveat.

pub fn build(self) -> Result<Workflow, Error>

Validate and build the group chat workflow.

Trait Implementations

impl Default for GroupChatBuilder

fn default() -> GroupChatBuilder

Returns the “default value” for a type.