Struct AgUiHook 

pub struct AgUiHook { /* private fields */ }

AG-UI Hook for streaming tool call events and state updates to frontends.

This hook implements rig’s PromptHook trait to capture tool calls and emit AG-UI protocol events via the EventBridge. It also maintains agent state for generative UI rendering.

Implementations

impl AgUiHook

pub fn new(event_bridge: EventBridge) -> Self

Creates a new AG-UI hook with the given event bridge.

pub async fn add_step(&self, description: impl Into<String>)

Adds a step and emits state update.

pub async fn complete_current_step(&self)

Completes the current step and emits state update.

Trait Implementations

impl Clone for AgUiHook

fn clone(&self) -> AgUiHook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> PromptHook<M> for AgUiHook

where M: CompletionModel,

fn on_tool_call( &self, tool_name: &str, _tool_call_id: Option<String>, args: &str, _cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called before a tool is invoked.

fn on_tool_result( &self, _tool_name: &str, _tool_call_id: Option<String>, _args: &str, result: &str, _cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called after a tool is invoked (and a result has been returned).

fn on_completion_response( &self, _prompt: &RigPromptMessage, _response: &CompletionResponse<M::Response>, _cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called after the prompt is sent to the model and a response is received.

fn on_completion_call( &self, prompt: &Message, history: &[Message], cancel_sig: CancelSignal, ) -> impl Future<Output = ()> + WasmCompatSend

Called before the prompt is sent to the model