Struct GraphInterruptPayload 

pub struct GraphInterruptPayload {
    pub kind: String,
    pub node: Option<String>,
    pub message: Option<String>,
    pub data: Option<Value>,
    pub thread_id: String,
    pub checkpoint_id: String,
}

A graph interrupt as it crosses the Agent boundary.

GraphAgent cannot return GraphError::Interrupted to a Runner: the trait yields events, and an error would end the invocation. It therefore emits one event carrying this payload, so a caller can read which node paused, why, and which checkpoint to resume from.

It travels as JSON in Event::provider_metadata under INTERRUPT_METADATA_KEY rather than as a field on adk_core::EventActions. A graph-shaped type in adk-core would put a Tier 3 concept in a Tier 1 crate; every other consumer of the event is unaffected by an extra metadata key.

Example

use adk_graph::interrupt::GraphInterruptPayload;
if let Some(pause) = GraphInterruptPayload::from_event(event) {
    println!("paused at {:?}: {:?}", pause.node, pause.message);
    // Resume by invoking the same thread again, supplying any decision.
}

Fields

kind: String

"before", "after", or "dynamic".

node: Option<String>

The gated node, for a static interrupt. None for a dynamic one, which carries a message instead.

message: Option<String>

The message a node supplied, for a dynamic interrupt.

data: Option<Value>

The data a node attached with NodeOutput::interrupt_with_data.

thread_id: String

The thread to resume.

checkpoint_id: String

The checkpoint the run stopped at.

Implementations

impl GraphInterruptPayload

pub fn new(interrupt: &Interrupt, thread_id: &str, checkpoint_id: &str) -> Self

Build a payload from an interrupt and the run it stopped.

pub fn from_event(event: &Event) -> Option<Self>

Read the payload from an event, or None if the event is not a graph interrupt.

pub fn to_metadata_value(&self) -> String

Serialize for transport in Event::provider_metadata.

Trait Implementations

impl Clone for GraphInterruptPayload

fn clone(&self) -> GraphInterruptPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphInterruptPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphInterruptPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphInterruptPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.