Skip to content

Realtime: forward all raw model events #1252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/agents/realtime/model_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,15 @@ class RealtimeModelExceptionEvent:
type: Literal["exception"] = "exception"


@dataclass
class RealtimeModelRawServerEvent:
"""Raw events forwarded from the server."""

data: Any

type: Literal["raw_server_event"] = "raw_server_event"


# TODO (rm) Add usage events


Expand All @@ -174,4 +183,5 @@ class RealtimeModelExceptionEvent:
RealtimeModelTurnEndedEvent,
RealtimeModelOtherEvent,
RealtimeModelExceptionEvent,
RealtimeModelRawServerEvent,
]
2 changes: 2 additions & 0 deletions src/agents/realtime/openai_realtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
RealtimeModelInputAudioTranscriptionCompletedEvent,
RealtimeModelItemDeletedEvent,
RealtimeModelItemUpdatedEvent,
RealtimeModelRawServerEvent,
RealtimeModelToolCallEvent,
RealtimeModelTranscriptDeltaEvent,
RealtimeModelTurnEndedEvent,
Expand Down Expand Up @@ -447,6 +448,7 @@ async def _cancel_response(self) -> None:
self._ongoing_response = False

async def _handle_ws_event(self, event: dict[str, Any]):
await self._emit_event(RealtimeModelRawServerEvent(data=event))
try:
if "previous_item_id" in event and event["previous_item_id"] is None:
event["previous_item_id"] = "" # TODO (rm) remove
Expand Down
2 changes: 2 additions & 0 deletions src/agents/realtime/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,8 @@ async def on_event(self, event: RealtimeModelEvent) -> None:
self._stored_exception = event.exception
elif event.type == "other":
pass
elif event.type == "raw_server_event":
pass
else:
assert_never(event)

Expand Down
32 changes: 16 additions & 16 deletions tests/realtime/test_openai_realtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,9 @@ async def test_handle_malformed_json_logs_error_continues(self, model):
# Malformed JSON should not crash the handler
await model._handle_ws_event("invalid json {")

# Should emit error event to listeners
mock_listener.on_event.assert_called_once()
error_event = mock_listener.on_event.call_args[0][0]
# Should emit raw server event and error event to listeners
assert mock_listener.on_event.call_count == 2
error_event = mock_listener.on_event.call_args_list[1][0][0]
assert error_event.type == "error"

@pytest.mark.asyncio
Expand All @@ -195,9 +195,9 @@ async def test_handle_invalid_event_schema_logs_error(self, model):

await model._handle_ws_event(invalid_event)

# Should emit error event to listeners
mock_listener.on_event.assert_called_once()
error_event = mock_listener.on_event.call_args[0][0]
# Should emit raw server event and error event to listeners
assert mock_listener.on_event.call_count == 2
error_event = mock_listener.on_event.call_args_list[1][0][0]
assert error_event.type == "error"

@pytest.mark.asyncio
Expand Down Expand Up @@ -241,9 +241,9 @@ async def test_handle_audio_delta_event_success(self, model):

await model._handle_ws_event(audio_event)

# Should emit audio event to listeners
mock_listener.on_event.assert_called_once()
emitted_event = mock_listener.on_event.call_args[0][0]
# Should emit raw server event and audio event to listeners
assert mock_listener.on_event.call_count == 2
emitted_event = mock_listener.on_event.call_args_list[1][0][0]
assert isinstance(emitted_event, RealtimeModelAudioEvent)
assert emitted_event.response_id == "resp_123"
assert emitted_event.data == b"test audio" # decoded from base64
Expand Down Expand Up @@ -274,9 +274,9 @@ async def test_handle_error_event_success(self, model):

await model._handle_ws_event(error_event)

# Should emit error event to listeners
mock_listener.on_event.assert_called_once()
emitted_event = mock_listener.on_event.call_args[0][0]
# Should emit raw server event and error event to listeners
assert mock_listener.on_event.call_count == 2
emitted_event = mock_listener.on_event.call_args_list[1][0][0]
assert isinstance(emitted_event, RealtimeModelErrorEvent)

@pytest.mark.asyncio
Expand All @@ -303,12 +303,12 @@ async def test_handle_tool_call_event_success(self, model):

await model._handle_ws_event(tool_call_event)

# Should emit both item updated and tool call events
assert mock_listener.on_event.call_count == 2
# Should emit raw server event, item updated, and tool call events
assert mock_listener.on_event.call_count == 3

# First should be item updated, second should be tool call
# First should be raw server event, second should be item updated, third should be tool call
calls = mock_listener.on_event.call_args_list
tool_call_emitted = calls[1][0][0]
tool_call_emitted = calls[2][0][0]
assert isinstance(tool_call_emitted, RealtimeModelToolCallEvent)
assert tool_call_emitted.name == "get_weather"
assert tool_call_emitted.arguments == '{"location": "San Francisco"}'
Expand Down