Skip to content

docs: clarify RunResult testing surface#5432

Open
nightcityblade wants to merge 1 commit intolivekit:mainfrom
nightcityblade:fix/issue-5410
Open

docs: clarify RunResult testing surface#5432
nightcityblade wants to merge 1 commit intolivekit:mainfrom
nightcityblade:fix/issue-5410

Conversation

@nightcityblade
Copy link
Copy Markdown

Fixes #5410

Summary

  • document RunResult.events as the primary minimal testing-facing surface
  • clarify that events stay typed and chronological for external consumers
  • note that final_output is optional and best treated as secondary

Testing

  • python3 -m compileall livekit-agents/livekit/agents/voice/run_result.py livekit-agents/livekit/agents/voice/agent_session.py

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


nightcityblade seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

@theomonnom
Copy link
Copy Markdown
Member

lgtm! but AgentSession.run is not only for testing. It can be used to build text apps

@nightcityblade
Copy link
Copy Markdown
Author

Good call, thanks. I agree AgentSession.run() is broader than a testing-only entrypoint. I opened a narrower follow-up docs PR around the small testing surface on RunResult.events instead of framing run() itself as test-only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: document a small testing-result surface around voice.testing.RunResult.events

3 participants