Skip to contents

GraphRunner R6 class

Source: R/runner.R
GraphRunner.Rd

The compiled, executable graph. Produced by StateGraph$compile(). Do not call GraphRunner$new() directly; use StateGraph$compile().

Value

The final WorkflowState object. If the run was paused at an interrupt point, the returned state reflects the graph at that moment; call $invoke() again with the same thread_id to resume.

A coro generator yielding list(node, state_snapshot, iteration).

State snapshot (named list) or NULL.

A data frame with columns agent, provider, model, input_tokens, output_tokens, cost.

Character string.

Character string.

Invisibly, path.

Methods

Public methods

Method new()

Initialise the runner. Called internally by StateGraph$compile().

Usage

GraphRunner$new(
  nodes,
  edges,
  conditional_edges,
  state_schema,
  agents,
  checkpointer,
  termination,
  output_channel = NULL,
  interrupt_before = character(),
  interrupt_after = character()
)

Arguments

nodes

Named list of list(fn = <function>).

edges

List of list(from, to).

conditional_edges

List of list(from, routing_fn, route_map).

state_schema

A WorkflowState object (used as schema template).

agents

Named list of Agent objects.

checkpointer

A Checkpointer or NULL.

termination

A termination_condition or NULL.

output_channel

Character or NULL. Name of the channel returned by WorkflowState$output() after $invoke().

interrupt_before

Character vector of node names to pause before.

interrupt_after

Character vector of node names to pause after.

Method invoke()

Execute the graph and return the final state.

Usage

GraphRunner$invoke(initial_state = list(), config = list())

Arguments

initial_state

Named list of initial channel overrides.

config

Named list of run-time configuration:

  • thread_id: character, identifies this run for checkpointing. Required when the graph has interrupt_before or interrupt_after points.

  • max_iterations: integer, cycle guard (default 25).

  • on_step: function(node_name, state) callback after each node (kept for backwards compatibility; prefer on_event).

  • on_event: function(event) callback fired around each node. event is a list with fields type ("node_start" or "node_end"), node (character), iteration (integer), and data (a list with field updates on "node_end", NULL on "node_start").

  • verbose: logical, print step info via cli (default FALSE).

Method stream()

Stream graph execution, yielding after each node.

Usage

GraphRunner$stream(initial_state = list(), config = list())

Arguments

initial_state

Named list of initial channel overrides.

config

Named list (same keys as $invoke()).

Method get_state()

Retrieve the last checkpointed state for a thread.

Usage

GraphRunner$get_state(thread_id)

Arguments

thread_id

Character.

Method update_state()

Manually update a checkpointed state (human-in-the-loop).

Usage

GraphRunner$update_state(thread_id, updates)

Arguments

thread_id

Character.

updates

Named list of channel updates.

Method cost_report()

Return a cost report across all agents.

Usage

GraphRunner$cost_report()

Method as_dot()

Generate a DOT language string for the graph.

Usage

GraphRunner$as_dot()

Method as_mermaid()

Generate a Mermaid diagram string.

Usage

GraphRunner$as_mermaid()

Method visualize()

Render a visualization of the compiled graph.

Usage

GraphRunner$visualize(engine = c("dot", "visnetwork", "mermaid"))

Arguments

engine

One of "dot", "visnetwork", or "mermaid".

Method export_diagram()

Export the diagram to a file.

Usage

GraphRunner$export_diagram(path, width = 800L, height = 600L)

Arguments

path

File path. Extension determines format (.svg or .png).

width

Integer. Width in pixels (PNG only).

height

Integer. Height in pixels (PNG only).

Method print()

Print runner summary.

Usage

GraphRunner$print(...)

Arguments

...

Ignored.

Method clone()

The objects of this class are cloneable with this method.

Usage

GraphRunner$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.