feat(ui): add finishReason in useChat onFinish callback #9857
Conversation
| @@ -1,3 +1,4 @@ | |||
| import { FinishReason } from '../types/language-model'; | |||
There was a problem hiding this comment.
I think this can be removed?
| expect(letOnFinishArgs).toMatchInlineSnapshot(` | ||
| [ | ||
| { | ||
| "finishReason": undefined, |
There was a problem hiding this comment.
I haven't looked in detail yet, but is there a case where finishReason would be undefined? We might need to update our fixtures in the tests
There was a problem hiding this comment.
I think so, finishReason can be undefined when there’s no finish event (abort, disconnect, server error). For normal completions it should be set (usually 'stop').
I’ve updated fixtures: normal paths include finishReason: 'stop'; abnormal paths keep it undefined.
This PR adds the finishReason parameter to the onFinish callback in useChat, allowing developers to know why a stream finished (stop, length, content-filter, tool-calls, etc.). Changes: - Added finishReason to ChatOnFinishCallback type - Updated UI message stream handling to propagate finishReason - Updated tests to verify finishReason is passed correctly - Added changeset for patch release
KirschX
force-pushed
the
feat/use-chat-onfinish-finish-reason
branch
from
3b8a2ad to
fe0f666
Compare
I updated one of a example file in 'examples/next-openai'(use-chat-data-ui-parts). Sorry for late update after requesting review. |
2 participants
Background
#9780
In order to use
finishReasonwithuseChaton the frontend, users currently have to manually send it from the server—either by adding it to metadata or usingcreateUIMessageStream.I raised a question in the discussion tab, and it seems worthwhile to include
finishReasonby default so developers can access it without additional setup.Summary
This PR adds the finishReason parameter to the onFinish callback in useChat, allowing developers to know why a stream finished (stop, length, content-filter, tool-calls, etc.).
Changes:
Manual Verification
Checklist
pnpm changesetin the project root)Future Work
Related Issues
closes #9780