feat(bookmarking): Add support for ui.Chat bookmarking (#1951)

Author: schloerke

CHANGELOG.md

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## New features
 
+* Added support for bookmarking Shiny applications. Bookmarking allows users to save the current state of an application and return to it later. This feature is available in both Shiny Core and Shiny Express. (#1870, #1915, #1919, #1920, #1922, #1934, #1938, #1945)
+  * To enable bookmarking in Express mode, set `shiny.express.app_opts(bookmark_store=)` during the app's initial construction.
+  * To enable bookmarking in Core mode, set `shiny.App(bookmark_store=)` when constructing the `app` object.
+
+* Added a new `.enable_bookmarking(client)` method to `ui.Chat()`. This method will attach bookmark hooks to save and restore the chat's messages and client state. (#1951)
+
 * Both `ui.Chat()` and `ui.MarkdownStream()` now support arbirary Shiny UI elements inside of messages. This allows for gathering input from the user (e.g., `ui.input_select()`), displaying of rich output (e.g., `render.DataGrid()`), and more. (#1868)
 
 * Added a new `.message_stream_context()` method to `ui.Chat()`. This context manager is a useful alternative to `.append_message_stream()` when you want to: (1) Nest a stream within another and/or

pyproject.toml

@@ -120,6 +120,7 @@ dev = [
     "langsmith<0.3",
     "openai",
     "ollama",
+    "chatlas>=0.6.1",
     "tokenizers",
     "aiohttp",
     "beautifulsoup4",

shiny/templates/chat/llm-enterprise/aws-bedrock-anthropic/app.py

@@ -28,6 +28,9 @@
 chat = ui.Chat(id="chat")
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Define a callback to run when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llm-enterprise/azure-openai/app.py

@@ -33,6 +33,9 @@
 )
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Define a callback to run when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llms/anthropic/app.py

@@ -33,6 +33,9 @@
 )
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Generate a response when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llms/google/app.py

@@ -29,6 +29,9 @@
 chat = ui.Chat(id="chat")
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Generate a response when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llms/langchain/app.py

@@ -34,6 +34,9 @@
 )
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Define a callback to run when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llms/ollama/app.py

@@ -25,6 +25,9 @@
 )
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Generate a response when the user submits a message
 @chat.on_user_submit

shiny/templates/chat/llms/openai/app.py

@@ -33,6 +33,9 @@
 )
 chat.ui()
 
+# Store chat state in the url when an "assistant" response occurs
+chat.enable_bookmarking(chat_client, bookmark_store="url")
+
 
 # Generate a response when the user submits a message
 @chat.on_user_submit