Add Streamlit Chat Migration Guide

[philippjfr]

Supersedes #5642

• Review and merge Improve PanelCallBackHandler basic #5682. The PanelCallbackHandler example depends on this.
• Upload assets and replace links

[philippjfr]

Not super convinced that we should add the ChatInput and ChatStatus examples.

[codecov]

Codecov Report

Merging #5670 (c73f5e6) into main (cb6cfb5) will decrease coverage by 0.01%.
Report is 2 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #5670      +/-   ##
==========================================
- Coverage   84.10%   84.10%   -0.01%     
==========================================
  Files         288      288              
  Lines       41990    41984       -6     
==========================================
- Hits        35317    35309       -8     
- Misses       6673     6675       +2     

Flag	Coverage Δ
ui-tests	40.79% <ø> (+<0.01%)	⬆️
unitexamples-tests	73.71% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 7 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[MarcSkovMadsen]

Questions

• Should we provide a ChatInput component similar to Streamlits chat_input?
• Should we provide a Status component similar to Streamlits status?

[MarcSkovMadsen]

Not super convinced that we should add the ChatInput and ChatStatus examples.

I assume its because the components code are long and not for beginners?

But since we dont have those components in Panel today, how do we guide users wanting to migrate?

[ahuang11]

If we have a ChatInput, I'd like it to be like the GitHub text box which lets users input both text and files by drag/drop.

But since we dont have those components in Panel today, how do we guide users wanting to migrate?

Isn't ChatInput equivalent to TextInput at the moment?

[philippjfr]

We definitely want a full featured ChatInput in the long run.

But since we dont have those components in Panel today, how do we guide users wanting to migrate?

I think it's much better to either skip that or say that we are working on it than scaring the user with a huge wall of text.

[MarcSkovMadsen]

Isn't ChatInput equivalent to TextInput at the moment?

TextInput is What we have at the moment. But they are not equivalent.

• the ChatInput combines a TextInput and Button.
• the TextInput is cleared (on html side) when entered or submitted.

The ChatInput is easier to use when submitting multiple messages.

I think we carve out the advanced ChatInput you have implemented in the ChatInterface and Expose that @ahuang11

[ahuang11]

Maybe in the future; I wouldn't want to hold up the Panel release any longer. Perhaps track it in a new issue?

[MarcSkovMadsen]

Agree that we should not hold up the Panel release.

My suggestion would be to

• make feature requests for ChatInput and Status. Phillip could comment in the request that he would like to accept a PR (if that is the case)

We could optionally

• move the ChatInput and Status components to the panel-chat-examples as "components" examples.

What do you think?

[ahuang11]

I like the idea of both.

[MarcSkovMadsen]

I've moved the ChatInput and Status components to holoviz-topics/panel-chat-examples#69. I will now document how to migrate 1) A basic chat example 2) a CallbackHandler example..

[MarcSkovMadsen]

Assets

streamlit_callback_handler.mp4

panel_callback_handler.mp4

[MarcSkovMadsen]

This one is ready for review @philippjfr . I cannot request it from you as you opened the PR.

[MarcSkovMadsen]

Thx