2223242526272829303132

@dataclassclassRealtimeAgentStartEvent:"""A new agent has started."""agent:RealtimeAgent"""The new agent."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["agent_start"]="agent_start"

3536373839404142434445

@dataclassclassRealtimeAgentEndEvent:"""An agent has ended."""agent:RealtimeAgent"""The agent that ended."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["agent_end"]="agent_end"

134135136137138139140141142143144145146147148149150

@dataclassclassRealtimeAudio:"""Triggered when the agent generates new audio to be played."""audio:RealtimeModelAudioEvent"""The audio event from the model layer."""item_id:str"""The ID of the item containing audio."""content_index:int"""The index of the audio content in `item.content`"""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["audio"]="audio"

118119120121122123124125126127128129130131

@dataclassclassRealtimeAudioEnd:"""Triggered when the agent stops generating audio."""info:RealtimeEventInfo"""Common info for all events, such as the context."""item_id:str"""The ID of the item containing audio."""content_index:int"""The index of the audio content in `item.content`"""type:Literal["audio_end"]="audio_end"

153154155156157158159160161162163164165166167168

@dataclassclassRealtimeAudioInterrupted:"""Triggered when the agent is interrupted. Can be listened to by the user to stop audio    playback or give visual indicators to the user.    """info:RealtimeEventInfo"""Common info for all events, such as the context."""item_id:str"""The ID of the item containing audio."""content_index:int"""The index of the audio content in `item.content`"""type:Literal["audio_interrupted"]="audio_interrupted"

6465666768697071727374757677787980

@dataclassclassRealtimeToolStart:"""An agent is starting a tool call."""agent:RealtimeAgent"""The agent that updated."""tool:Tool"""The tool being called."""arguments:str"""The arguments passed to the tool as a JSON string."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["tool_start"]="tool_start"

 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99100101102

@dataclassclassRealtimeToolEnd:"""An agent has ended a tool call."""agent:RealtimeAgent"""The agent that ended the tool call."""tool:Tool"""The tool that was called."""arguments:str"""The arguments passed to the tool as a JSON string."""output:Any"""The output of the tool call."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["tool_end"]="tool_end"

4849505152535455565758596061

@dataclassclassRealtimeHandoffEvent:"""An agent has handed off to another agent."""from_agent:RealtimeAgent"""The agent that handed off."""to_agent:RealtimeAgent"""The agent that was handed off to."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["handoff"]="handoff"

210211212213214215216217218219220221222223

@dataclassclassRealtimeGuardrailTripped:"""A guardrail has been tripped and the agent has been interrupted."""guardrail_results:list[OutputGuardrailResult]"""The results from all triggered guardrails."""message:str"""The message that was being generated when the guardrail was triggered."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["guardrail_tripped"]="guardrail_tripped"

197198199200201202203204205206207

@dataclassclassRealtimeHistoryAdded:"""A new item has been added to the history."""item:RealtimeItem"""The new item that was added to the history."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["history_added"]="history_added"

184185186187188189190191192193194

@dataclassclassRealtimeHistoryUpdated:"""The history has been updated. Contains the full history of the session."""history:list[RealtimeItem]"""The full history of the session."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["history_updated"]="history_updated"

171172173174175176177178179180181

@dataclassclassRealtimeError:"""An error has occurred."""error:Any"""The error that occurred."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["error"]="error"

105106107108109110111112113114115

@dataclassclassRealtimeRawModelEvent:"""Forwards raw events from the model layer."""data:RealtimeModelEvent"""The raw data from the model layer."""info:RealtimeEventInfo"""Common info for all events, such as the context."""type:Literal["raw_model_event"]="raw_model_event"