Is there any reason that there's no 'finishReason' on useChat hook?

[KirschX]

Hello!

During making an application with this library, I wanted to retrieve 'finish reason' but I couldn't find something like this especially on useChat hook.

I think it's so necessary for many use cases but couldn't find for my case after reading all the documents.

So I ended up with an workaround which used createUIMessageStream on server and added custom 'finish-reason' type data for returning data.

Is there something I missed?

If not, I want to know is there any reason for this and would like to contribute for this feature if there's no reason.

[lgrammel]

You can control the message metadata (since you may not want to expose the finish reason to the user). If you need it, you can it via message metadata, but this is good feedback and may be worth adding by default.

[KirschX]

Thank you for your feedback!
I’ve created a PR implementing the finishReason idea: #9857

I’d really appreciate it if you could take a look when you have time.

[github-actions[bot]]

This discussion was automatically locked because it has not been updated in over 30 days. If you still have questions about this topic, please ask us at community.vercel.com/ai-sdk