Update StreamUI documentation for advanced use cases (Agentic workflow) #2421
Conversation
This file contains 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
derekyhsieh
changed the title
derekyhsieh
changed the title
lgrammel
reviewed
Jul 28, 2024
Comment on lines
+219
to
+237
| generate: async function* ({ specifications }) { | ||
| yield <LoadingComponent message="Generating dashboard..." />; | ||
|
|
||
| const dashboardResult = await streamUI({ | ||
| model: openai('gpt-4'), | ||
| prompt: `Create a dashboard with the following specifications: ${specifications}`, | ||
| text: ({ content, done, delta }) => { | ||
| // Handle streaming text updates here | ||
| return <DashboardGenerationProgress content={content} />; | ||
| }, | ||
| tools: { | ||
| // Additional tools for dashboard generation can be defined here | ||
| } | ||
| }); | ||
|
|
||
| return <DashboardComponent>{dashboardResult.value}</DashboardComponent>; | ||
| }, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
I'm a bit torn about this pattern and whether we want to promote it, since it leads to complications with creating a consistent chat history, especially with parallel tool calling.
I plan to revisit this once I'm done with the streamUI refactoring.
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.
Add advanced use case for nesting streamUI functions within toolcalls for streaming text for long running tool-calls (code generation) that require constant UI updates via text streaming