Interface ISwarmCompletionArgs

Interface representing the arguments for swarm (chat) completions. Extends base completion args with swarm-specific fields for agent-based interactions. Used for agent completions with tool support, client tracking, and multi-agent context. ISwarmCompletionArgs

interface ISwarmCompletionArgs {
    agentName: string;
    clientId: string;
    messages: ISwarmMessage<object>[];
    mode: ExecutionMode;
    tools?: ITool[];
}

Hierarchy (View Summary)

Properties

agentName: string

The agent name (required). Identifies the agent context for the completion.

clientId: string

client identifier for tracking and error handling.

messages: ISwarmMessage<object>[]

An array of messages providing the conversation history or context for the completion.

mode: ExecutionMode

The source of the last message, indicating whether it originated from a tool or user.

tools?: ITool[]

Optional array of tools available for this completion. Enables the model to call functions and interact with external systems.