Skip to content

docs: clarify RunResult.events testing surface #5441

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.

Sign up for GitHub

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

Open
nightcityblade wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Open

docs: clarify RunResult.events testing surface #5441

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion livekit-agents/livekit/agents/voice/run_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,17 @@ def __init__(self, *, user_input: str | None = None, output_type: type[Run_T] |

@property
def events(self) -> list[RunEvent]:
"""List of all recorded events generated during the run."""
"""List of recorded run events in chronological order.

This surface is intentionally small and testing-oriented. Each item is one of:
- ``ChatMessageEvent`` for chat messages
- ``FunctionCallEvent`` for tool/function calls
- ``FunctionCallOutputEvent`` for tool/function results
- ``AgentHandoffEvent`` for agent transitions

Use this to assert on the observable flow of a run in tests without depending
on lower-level session internals, room state, or raw media artifacts.
"""
return self._recorded_items

@functools.cached_property
Expand Down