shinychat Reference

Shiny Core

Chat Create a chat interface.
types.ChatClient Wraps a chatlas client bound to a :class:~shinychat.Chat instance.
types.ChatMessage
types.Attachment An image, PDF, or text file to attach to a chat message.
chat_ui UI container for a chat component (Shiny Core).
chat_greeting Create a greeting for a chat UI.

Page chat

types.ChatDrawerController Control the artifact panel associated with a :class:~shinychat.Chat.
page_chat Create a full-window page containing one persistent chat interface.
page_chat_theme Create a theme for :func:~shinychat.page_chat.
chat_sidebar Configure a sidebar for :func:~shinychat.page_chat.
chat_nav_panel Configure a secondary navigation page for :func:~shinychat.page_chat.
chat_drawer Configure content displayed adjacent to a chat interface.
chat_ui_history Create a conversation-history view bound to a chat.

Tool display

types.ToolResultDisplay Customize the condensed display for a tool result.
message_content Extract content from various message types into a ChatMessage.
message_content_chunk Extract content from various message chunk types into a ChatMessage.

Shiny Express

express.Chat
express.page_chat Create the sole top-level UI item for a full-window Express chat page.

Conversation history

types.HistoryOptions Configuration for :class:~shinychat.Chat conversation history.
types.ConversationPartition Storage partition for a chat history collection.
types.ConversationStore Storage interface for chat conversation history.
types.FileConversationStore Default store: each conversation is a directory at
types.ConversationRecord
types.ConversationMeta

Testing

playwright.ChatController Controller for :func:shiny.ui.chat.