Class AgentOSOrchestrator

AgentOSOrchestrator

Description

The AgentOSOrchestrator is responsible for unifying the request handling pipeline for AgentOS. It bridges the high-level AgentOSInput from the public API to the internal GMI processing logic. It ensures that user requests are routed to the correct GMI, manages the GMI's turn lifecycle, and handles the complex dance of tool calls and streaming responses.

Constructors

constructor

Methods

initialize broadcastWorkflowUpdate orchestrateTurn orchestrateToolResult shutdown

Constructors

constructor

Methods

initialize

  • initialize(config, dependencies): Promise<void>

  • Initializes the AgentOSOrchestrator with its configuration and dependencies. This method must be called successfully before orchestrating any turns.

    Parameters

    Returns Promise<void>

    A Promise that resolves when initialization is complete.

    Async

    Throws

    If any critical dependency is missing or config is invalid.

broadcastWorkflowUpdate

orchestrateTurn

  • orchestrateTurn(input): Promise<string>

  • Orchestrates a full logical turn for a user request. This involves managing GMI interaction, tool calls, and streaming responses. Instead of directly yielding, it uses the StreamingManager to push chunks.

    Parameters

    • input: AgentOSInput

      The comprehensive input for the current turn.

    Returns Promise<string>

    The ID of the stream to which responses will be pushed.

    Async

    Throws

    If critical initialization or setup fails.

orchestrateToolResult

  • orchestrateToolResult(agentOSStreamId, toolCallId, toolName, toolOutput, isSuccess, errorMessage?): Promise<void>

  • Handles the result of an external tool execution, feeding it back into the relevant GMI instance for continued processing. Uses StreamingManager to push subsequent GMI outputs.

    Parameters

    • agentOSStreamId: string

      The orchestrator's stream ID for this interaction flow.

    • toolCallId: string

      The ID of the tool call being responded to.

    • toolName: string

      The name of the tool.

    • toolOutput: any

      The output from the tool.

    • isSuccess: boolean

      Whether the tool execution was successful.

    • Optional errorMessage: string

      Error message if not successful.

    Returns Promise<void>

    Async

    Throws

    If stream context is not found or GMI fails to handle result.

shutdown

  • shutdown(): Promise<void>

  • Shuts down the AgentOSOrchestrator. Currently, this mainly involves clearing active stream contexts. Dependencies like GMIManager are assumed to be shut down by AgentOS.

    Returns Promise<void>

    A promise that resolves when shutdown is complete.

    Async

Settings

Member Visibility

Theme

On This Page

constructorinitializebroadcastWorkflowUpdateorchestrateTurnorchestrateToolResultshutdown