shinychat 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

shinychat/__init__.py

@@ -1,4 +1,12 @@
 from ._chat import Chat, chat_ui
+from ._chat_normalize import message_content, message_content_chunk
 from ._markdown_stream import MarkdownStream, output_markdown_stream
 
-__all__ = ["Chat", "chat_ui", "MarkdownStream", "output_markdown_stream"]
+__all__ = [
+    "Chat",
+    "chat_ui",
+    "MarkdownStream",
+    "output_markdown_stream",
+    "message_content",
+    "message_content_chunk",
+]

shinychat/__version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.2.1'
+__version_tuple__ = version_tuple = (0, 2, 1)
+
+__commit_id__ = commit_id = None

shinychat/_chat.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import warnings
 from contextlib import asynccontextmanager
 from typing import (
     TYPE_CHECKING,
@@ -21,7 +22,7 @@ from weakref import WeakValueDictionary
 
 from htmltools import (
     HTML,
-    RenderedHTML,
+    HTMLDependency,
     Tag,
     TagAttrValue,
     TagChild,
@@ -52,9 +53,10 @@ from ._chat_bookmark import (
     is_chatlas_chat_client,
     set_chatlas_state,
 )
-from ._chat_normalize import normalize_message, normalize_message_chunk
+from ._chat_normalize import message_content, message_content_chunk
+from ._chat_normalize_chatlas import hide_corresponding_request, is_tool_result
 from ._chat_provider_types import (
-    AnthropicMessage,
+    AnthropicMessage,  # pyright: ignore[reportAttributeAccessIssue]
     GoogleMessage,
     LangChainMessage,
     OllamaMessage,
@@ -182,21 +184,7 @@ class Chat:
         A unique identifier for the chat session. In Shiny Core, make sure this id
         matches a corresponding :func:`~shiny.ui.chat_ui` call in the UI.
     messages
-        A sequence of messages to display in the chat. A given message can be one of the
-        following:
-
-        * A string, which is interpreted as markdown and rendered to HTML on the client.
-            * To prevent interpreting as markdown, mark the string as
-              :class:`~shiny.ui.HTML`.
-        * A UI element (specifically, a :class:`~shiny.ui.TagChild`).
-            * This includes :class:`~shiny.ui.TagList`, which take UI elements
-              (including strings) as children. In this case, strings are still
-              interpreted as markdown as long as they're not inside HTML.
-        * A dictionary with `content` and `role` keys. The `content` key can contain a
-          content as described above, and the `role` key can be "assistant" or "user".
-
-        **NOTE:** content may include specially formatted **input suggestion** links
-        (see `.append_message()` for more information).
+        Deprecated. Use `chat.ui(messages=...)` instead.
     on_error
         How to handle errors that occur in response to user input. When `"unhandled"`,
         the app will stop running when an error occurs. Otherwise, a notification
@@ -208,11 +196,8 @@ class Chat:
         * `"sanitize"`: Sanitize the error message before displaying it to the user.
         * `"unhandled"`: Do not display any error message to the user.
     tokenizer
-        The tokenizer to use for calculating token counts, which is required to impose
-        `token_limits` in `.messages()`. If not provided, a default generic tokenizer
-        is attempted to be loaded from the tokenizers library. A specific tokenizer
-        may also be provided by following the `TokenEncoding` (tiktoken or tozenizers)
-        protocol (e.g., `tiktoken.encoding_for_model("gpt-4o")`).
+        Deprecated. Token counting and message trimming features will be removed in a
+        future version.
     """
 
     def __init__(
@@ -226,6 +211,17 @@ class Chat:
         if not isinstance(id, str):
             raise TypeError("`id` must be a string.")
 
+        if messages:
+            warn_deprecated(
+                "`Chat(messages=...)` is deprecated. Use `.ui(messages=...)` instead."
+            )
+
+        if tokenizer is not None:
+            warn_deprecated(
+                "`Chat(tokenizer=...)` is deprecated. "
+                "This is only relevant for `.messages(token_limits=...)` which is also now deprecated."
+            )
+
         self.id = resolve_id(id)
         self.user_input_id = ResolvedId(f"{self.id}_user_input")
         self._transform_user: TransformUserInputAsync | None = None
@@ -381,7 +377,9 @@ class Chat:
                             "A on_user_submit function should not take more than 1 argument"
                         )
                     elif len(fn_params) == 1:
-                        input = self.user_input(transform=True)
+                        with warnings.catch_warnings():
+                            warnings.simplefilter("ignore")
+                            input = self.user_input(transform=True)
                         # The line immediately below handles the possibility of input
                         # being transformed to None. Technically, input should never be
                         # None at this point (since the handler should be suspended).
@@ -486,48 +484,22 @@ class Chat:
         """
         Reactively read chat messages
 
-        Obtain chat messages within a reactive context. The default behavior is
-        intended for passing messages along to a model for response generation where
-        you typically want to:
-
-        1. Cap the number of tokens sent in a single request (i.e., `token_limits`).
-        2. Apply user input transformations (i.e., `transform_user`), if any.
-        3. Not apply assistant response transformations (i.e., `transform_assistant`)
-           since these are predominantly for display purposes (i.e., the model shouldn't
-           concern itself with how the responses are displayed).
+        Obtain chat messages within a reactive context.
 
         Parameters
         ----------
         format
-            The message format to return. The default value of `MISSING` means
-            chat messages are returned as :class:`ChatMessage` objects (a dictionary
-            with `content` and `role` keys). Other supported formats include:
-
-            * `"anthropic"`: Anthropic message format.
-            * `"google"`: Google message (aka content) format.
-            * `"langchain"`: LangChain message format.
-            * `"openai"`: OpenAI message format.
-            * `"ollama"`: Ollama message format.
+            Deprecated. Provider-specific message formatting will be removed in a future
+            version.
         token_limits
-            Limit the conversation history based on token limits. If specified, only
-            the most recent messages that fit within the token limits are returned. This
-            is useful for avoiding "exceeded token limit" errors when sending messages
-            to the relevant model, while still providing the most recent context available.
-            A specified value must be a tuple of two integers. The first integer is the
-            maximum number of tokens that can be sent to the model in a single request.
-            The second integer is the amount of tokens to reserve for the model's response.
-            Note that token counts based on the `tokenizer` provided to the `Chat`
-            constructor.
+            Deprecated. Token counting and message trimming features will be removed in
+            a future version.
         transform_user
-            Whether to return user input messages with transformation applied. This only
-            matters if a `transform_user_input` was provided to the chat constructor.
-            The default value of `"all"` means all user input messages are transformed.
-            The value of `"last"` means only the last user input message is transformed.
-            The value of `"none"` means no user input messages are transformed.
+            Deprecated. Message transformation features will be removed in a future
+            version.
         transform_assistant
-            Whether to return assistant messages with transformation applied. This only
-            matters if an `transform_assistant_response` was provided to the chat
-            constructor.
+            Deprecated. Message transformation features will be removed in a future
+            version.
 
         Note
         ----
@@ -541,6 +513,34 @@ class Chat:
             A tuple of chat messages.
         """
 
+        if not isinstance(format, MISSING_TYPE):
+            warn_deprecated(
+                "`.messages(format=...)` is deprecated. "
+                "Provider-specific message formatting will be removed in a future version. "
+                "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+            )
+
+        if token_limits is not None:
+            warn_deprecated(
+                "`.messages(token_limits=...)` is deprecated. "
+                "Token counting and message trimming features will be removed in a future version. "
+                "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+            )
+
+        if transform_user != "all":
+            warn_deprecated(
+                "`.messages(transform_user=...)` is deprecated. "
+                "Message transformation features will be removed in a future version. "
+                "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+            )
+
+        if transform_assistant:
+            warn_deprecated(
+                "`.messages(transform_assistant=...)` is deprecated. "
+                "Message transformation features will be removed in a future version. "
+                "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+            )
+
         messages = self._messages()
 
         # Anthropic requires a user message first and no system messages
@@ -595,6 +595,7 @@ class Chat:
             * A dictionary with `content` and `role` keys. The `content` key can contain
               content as described above, and the `role` key can be "assistant" or
               "user".
+            * More generally, any type registered with :func:`shinychat.message_content`.
 
             **NOTE:** content may include specially formatted **input suggestion** links
             (see note below).
@@ -636,7 +637,7 @@ class Chat:
             self._pending_messages.append((message, False, "append", None))
             return
 
-        msg = normalize_message(message)
+        msg = message_content(message)
         msg = await self._transform_message(msg)
         if msg is None:
             return
@@ -753,7 +754,10 @@ class Chat:
         self._current_stream_id = stream_id
 
         # Normalize various message types into a ChatMessage()
-        msg = normalize_message_chunk(message)
+        msg = message_content_chunk(message)
+
+        if is_tool_result(message):
+            await hide_corresponding_request(message)
 
         if operation == "replace":
             self._current_stream_message = (
@@ -826,6 +830,7 @@ class Chat:
             * A dictionary with `content` and `role` keys. The `content` key can contain
               content as described above, and the `role` key can be "assistant" or
               "user".
+            * More generally, any type registered with :func:`shinychat.message_content_chunk`.
 
             **NOTE:** content may include specially formatted **input suggestion** links
             (see note below).
@@ -1020,25 +1025,15 @@ class Chat:
         self, fn: TransformUserInput | TransformUserInputAsync | None = None
     ) -> None | Callable[[TransformUserInput | TransformUserInputAsync], None]:
         """
-        Transform user input.
-
-        Use this method as a decorator on a function (`fn`) that transforms user input
-        before storing it in the chat messages returned by `.messages()`. This is
-        useful for implementing RAG workflows, like taking a URL and scraping it for
-        text before sending it to the model.
-
-        Parameters
-        ----------
-        fn
-            A function to transform user input before storing it in the chat
-            `.messages()`. If `fn` returns `None`, the user input is effectively
-            ignored, and `.on_user_submit()` callbacks are suspended until more input is
-            submitted. This behavior is often useful to catch and handle errors that
-            occur during transformation. In this case, the transform function should
-            append an error message to the chat (via `.append_message()`) to inform the
-            user of the error.
+        Deprecated. User input transformation features will be removed in a future version.
         """
 
+        warn_deprecated(
+            "The `.transform_user_input` decorator is deprecated. "
+            "User input transformation features will be removed in a future version. "
+            "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+        )
+
         def _set_transform(fn: TransformUserInput | TransformUserInputAsync):
             self._transform_user = _utils.wrap_async(fn)
 
@@ -1062,31 +1057,15 @@ class Chat:
         fn: TransformAssistantResponseFunction | None = None,
     ) -> None | Callable[[TransformAssistantResponseFunction], None]:
         """
-        Transform assistant responses.
-
-        Use this method as a decorator on a function (`fn`) that transforms assistant
-        responses before displaying them in the chat. This is useful for post-processing
-        model responses before displaying them to the user.
-
-        Parameters
-        ----------
-        fn
-            A function that takes a string and returns either a string,
-            :class:`shiny.ui.HTML`, or `None`. If `fn` returns a string, it gets
-            interpreted and parsed as a markdown on the client (and the resulting HTML
-            is then sanitized). If `fn` returns :class:`shiny.ui.HTML`, it will be
-            displayed as-is. If `fn` returns `None`, the response is effectively ignored.
-
-        Note
-        ----
-        When doing an `.append_message_stream()`, `fn` gets called on every chunk of the
-        response (thus, it should be performant), and can optionally access more
-        information (i.e., arguments) about the stream. The 1st argument (required)
-        contains the accumulated content, the 2nd argument (optional) contains the
-        current chunk, and the 3rd argument (optional) is a boolean indicating whether
-        this chunk is the last one in the stream.
+        Deprecated. Assistant response transformation features will be removed in a future version.
         """
 
+        warn_deprecated(
+            "The `.transform_assistant_response` decorator is deprecated. "
+            "Assistant response transformation features will be removed in a future version. "
+            "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+        )
+
         def _set_transform(
             fn: TransformAssistantResponseFunction,
         ):
@@ -1303,6 +1282,14 @@ class Chat:
           2. Maintaining message state separately from `.messages()`.
 
         """
+
+        if transform:
+            warn_deprecated(
+                "`.user_input(transform=...)` is deprecated. "
+                "User input transformation features will be removed in a future version. "
+                "See here for more details: https://github.com/posit-dev/shinychat/pull/91"
+            )
+
         msg = self._latest_user_input()
         if msg is None:
             return None
@@ -1603,7 +1590,9 @@ class ChatExpress(Chat):
     def ui(
         self,
         *,
-        messages: Optional[Sequence[TagChild | ChatMessageDict]] = None,
+        messages: Optional[
+            Iterable[str | TagChild | ChatMessageDict | ChatMessage | Any]
+        ] = None,
         placeholder: str = "Enter a message...",
         width: CssUnit = "min(680px, 100%)",
         height: CssUnit = "auto",
@@ -1705,12 +1694,14 @@ class ChatExpress(Chat):
 def chat_ui(
     id: str,
     *,
-    messages: Optional[Sequence[TagChild | ChatMessageDict]] = None,
+    messages: Optional[
+        Iterable[str | TagChild | ChatMessageDict | ChatMessage | Any]
+    ] = None,
     placeholder: str = "Enter a message...",
     width: CssUnit = "min(680px, 100%)",
     height: CssUnit = "auto",
     fill: bool = True,
-    icon_assistant: HTML | Tag | TagList | None = None,
+    icon_assistant: Optional[HTML | Tag | TagList] = None,
     **kwargs: TagAttrValue,
 ) -> Tag:
     """
@@ -1737,6 +1728,7 @@ def chat_ui(
               interpreted as markdown as long as they're not inside HTML.
         * A dictionary with `content` and `role` keys. The `content` key can contain a
           content as described above, and the `role` key can be "assistant" or "user".
+        * More generally, any type registered with :func:`shinychat.message_content`.
 
         **NOTE:** content may include specially formatted **input suggestion** links
         (see :method:`~shiny.ui.Chat.append_message` for more info).
@@ -1770,38 +1762,14 @@ def chat_ui(
     if messages is None:
         messages = []
     for x in messages:
-        role = "assistant"
-        content: TagChild = None
-        if not isinstance(x, dict):
-            content = x
-        else:
-            if "content" not in x:
-                raise ValueError(
-                    "Each message dictionary must have a 'content' key."
-                )
-
-            content = x["content"]
-            if "role" in x:
-                role = x["role"]
-
-        # `content` is most likely a string, so avoid overhead in that case
-        # (it's also important that we *don't escape HTML* here).
-        if isinstance(content, str):
-            ui: RenderedHTML = {"html": content, "dependencies": []}
-        else:
-            ui = TagList(content).render()
-
-        if role == "user":
-            tag_name = "shiny-user-message"
-        else:
-            tag_name = "shiny-chat-message"
-
+        msg = message_content(x)
         message_tags.append(
             Tag(
-                tag_name,
-                ui["dependencies"],
-                content=ui["html"],
+                "shiny-chat-message",
+                *[HTMLDependency(**d) for d in msg.html_deps],
+                content=msg.content,
                 icon=icon_attr,
+                data_role=msg.role,
             )
         )