docs: add multi-step usechat suggestion #3467
Open
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
lgrammel
reviewed
Nov 4, 2024
Comment on lines
+99
to
+113
| ## Multi-Step Calls with `useChat` | ||
|
|
||
| To access multi-step calls on the client with [ `useChat` ](/docs/reference/ai-sdk-ui/use-chat), you should set `maxSteps` within the `useChat` options rather than within the `generateText` or `streamText` call. This will allow you to access all steps in callbacks like `onToolCall` and `onFinish`. | ||
|
|
||
| ```tsx highlight="2" | ||
| const { messages } = useChat({ | ||
| maxSteps: 3, | ||
| onFinish: message => { | ||
| // access message from each step | ||
| }, | ||
| onToolCall: ({ toolCall }) => { | ||
| // access tool call from each step | ||
| }, | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
Hmm they need to work in combination. Server side roundtrips have many advantages.
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.
No description provided.