Struct RealtimeAgentBuilder 

pub struct RealtimeAgentBuilder { /* private fields */ }

Available on crate feature realtime only.

Builder for RealtimeAgent.

Implementations

impl RealtimeAgentBuilder

pub fn new(name: impl Into<String>) -> RealtimeAgentBuilder

Create a new builder with the given agent name.

pub fn description(self, desc: impl Into<String>) -> RealtimeAgentBuilder

Set the agent description.

pub fn model(self, model: Arc<dyn RealtimeModel>) -> RealtimeAgentBuilder

Set the realtime model.

pub fn instruction(self, instruction: impl Into<String>) -> RealtimeAgentBuilder

Set a static instruction.

pub fn instruction_provider( self, provider: Box<dyn Fn(Arc<dyn ReadonlyContext>) -> Pin<Box<dyn Future<Output = Result<String, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set a dynamic instruction provider.

pub fn global_instruction( self, instruction: impl Into<String>, ) -> RealtimeAgentBuilder

Set a static global instruction.

pub fn global_instruction_provider( self, provider: Box<dyn Fn(Arc<dyn ReadonlyContext>) -> Pin<Box<dyn Future<Output = Result<String, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set a dynamic global instruction provider.

pub fn voice(self, voice: impl Into<String>) -> RealtimeAgentBuilder

Set the voice for audio output.

pub fn vad(self, config: VadConfig) -> RealtimeAgentBuilder

Set voice activity detection configuration.

pub fn server_vad(self) -> RealtimeAgentBuilder

Enable server-side VAD with default settings.

pub fn modalities(self, modalities: Vec<String>) -> RealtimeAgentBuilder

Set output modalities (e.g., [“text”, “audio”]).

pub fn tool(self, tool: Arc<dyn Tool>) -> RealtimeAgentBuilder

Add a tool.

pub fn toolset(self, toolset: Arc<dyn Toolset>) -> RealtimeAgentBuilder

Register a dynamic toolset for per-invocation tool resolution.

Toolsets are resolved at the start of each run() call using the invocation’s ReadonlyContext. This enables context-dependent tools like per-user browser sessions from a pool.

pub fn sub_agent(self, agent: Arc<dyn Agent>) -> RealtimeAgentBuilder

Add a sub-agent for handoffs.

pub fn before_agent_callback( self, callback: Box<dyn Fn(Arc<dyn CallbackContext>) -> Pin<Box<dyn Future<Output = Result<Option<Content>, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Add a before-agent callback.

pub fn after_agent_callback( self, callback: Box<dyn Fn(Arc<dyn CallbackContext>) -> Pin<Box<dyn Future<Output = Result<Option<Content>, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Add an after-agent callback.

pub fn before_tool_callback( self, callback: Box<dyn Fn(Arc<dyn CallbackContext>) -> Pin<Box<dyn Future<Output = Result<Option<Content>, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Add a before-tool callback.

pub fn after_tool_callback( self, callback: Box<dyn Fn(Arc<dyn CallbackContext>) -> Pin<Box<dyn Future<Output = Result<Option<Content>, AdkError>> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Add an after-tool callback.

pub fn on_audio( self, callback: Arc<dyn Fn(&[u8], &str) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set callback for audio output events.

pub fn on_transcript( self, callback: Arc<dyn Fn(&str, &str) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set callback for transcript events.

pub fn on_speech_started( self, callback: Arc<dyn Fn(u64) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set callback for speech started events.

pub fn on_speech_stopped( self, callback: Arc<dyn Fn(u64) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>, ) -> RealtimeAgentBuilder

Set callback for speech stopped events.

pub fn build(self) -> Result<RealtimeAgent, AdkError>

Build the RealtimeAgent.