feat: add real-time streaming for generator tool preliminary results#127
Closed
mattapperson wants to merge 1 commit intomulti-turnfrom
Closed
feat: add real-time streaming for generator tool preliminary results#127mattapperson wants to merge 1 commit intomulti-turnfrom
mattapperson wants to merge 1 commit intomulti-turnfrom
Conversation
Generator tools can now stream preliminary results in real-time as they yield, rather than batch-emitting them after all tool execution completes. Changes: - Add ToolEventBroadcaster class for push-based multi-consumer event delivery - Update executeToolRound to pass onPreliminaryResult callback to executeTool - Add executeToolsWithBroadcast method for real-time streaming flows - Update getToolStream and getFullResponsesStream for real-time delivery - Export ToolEventBroadcaster for advanced use cases This enables streaming UI updates during long-running tool operations, similar to Vercel AI SDK's streaming preliminary tool outputs feature.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ToolEventBroadcasterclass for push-based multi-consumer event delivery following theReusableReadableStreampatterngetToolStream()andgetFullResponsesStream()to deliver events in real-timeMotivation
Similar to Vercel AI SDK v6's streaming preliminary tool outputs feature. This enables streaming UI updates during long-running tool operations - users can see progress as it happens rather than waiting for completion.
Changes
src/lib/tool-event-broadcaster.ts- Push-based broadcaster with buffering and multiple consumer supportsrc/lib/model-result.ts- AddedexecuteToolsWithBroadcast()method, updated stream methodsToolEventBroadcasterexported for advanced use casesUsage
Test plan
ToolEventBroadcaster(11 tests covering single/multiple consumers, async waiting, error handling)getToolStream()andgetFullResponsesStream()