Move chat components into its own namespace

examples/reference/widgets/ChatEntry.ipynb → examples/reference/chat/ChatEntry.ipynb

@@ -9,7 +9,7 @@
     "import asyncio\n",
     "\n",
     "import panel as pn\n",
-    "from panel.widgets import ChatEntry\n",
+    "from panel.chat import ChatEntry\n",
     "\n",
     "pn.extension()\n"
    ]
@@ -175,7 +175,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chat_entry = pn.widgets.ChatEntry()\n",
+    "chat_entry = pn.chat.ChatEntry()\n",
     "chat_entry"
    ]
   },
@@ -266,7 +266,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatEntry(timestamp_format=\"%b %d, %Y %I:%M %p\")"
+    "pn.chat.ChatEntry(timestamp_format=\"%b %d, %Y %I:%M %p\")"
    ]
   },
   {
@@ -328,7 +328,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatEntry(value=\"Love this!\", reactions=[\"favorite\"])"
+    "pn.chat.ChatEntry(value=\"Love this!\", reactions=[\"favorite\"])"
    ]
   },
   {
@@ -344,7 +344,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "entry = pn.widgets.ChatEntry(\n",
+    "entry = pn.chat.ChatEntry(\n",
     "    value=\"Looks good!\",\n",
     "    reactions=[\"like\"],\n",
     "    reaction_icons={\"like\": \"thumb-up\", \"dislike\": \"thumb-down\"},\n",

examples/reference/widgets/ChatFeed.ipynb → examples/reference/chat/ChatFeed.ipynb

@@ -82,7 +82,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chat_feed = pn.widgets.ChatFeed()\n",
+    "chat_feed = pn.chat.ChatFeed()\n",
     "chat_feed"
    ]
   },
@@ -147,9 +147,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatFeed(value=[\n",
-    "    pn.widgets.ChatEntry(value=\"I'm an emoji!\", avatar=\"🤖\"),\n",
-    "    pn.widgets.ChatEntry(value=\"I'm an image!\", avatar=\"https://upload.wikimedia.org/wikipedia/commons/6/63/Yumi_UBports.png\"),\n",
+    "pn.chat.ChatFeed(value=[\n",
+    "    pn.chat.ChatEntry(value=\"I'm an emoji!\", avatar=\"🤖\"),\n",
+    "    pn.chat.ChatEntry(value=\"I'm an image!\", avatar=\"https://upload.wikimedia.org/wikipedia/commons/6/63/Yumi_UBports.png\"),\n",
     "])"
    ]
   },
@@ -187,7 +187,7 @@
     "def echo_message(contents, user, instance):\n",
     "    return f\"Echoing... {contents}\"\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=echo_message)\n",
+    "chat_feed = pn.chat.ChatFeed(callback=echo_message)\n",
     "chat_feed"
    ]
   },
@@ -213,7 +213,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chat_feed = pn.widgets.ChatFeed(callback=echo_message, callback_user=\"Echo Bot\")\n",
+    "chat_feed = pn.chat.ChatFeed(callback=echo_message, callback_user=\"Echo Bot\")\n",
     "chat_feed"
    ]
   },
@@ -242,7 +242,7 @@
     "def parrot_message(contents, user, instance):\n",
     "    return {\"value\": f\"No, {contents.lower()}\", \"user\": \"Parrot\", \"avatar\": \"🦜\"}\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=parrot_message, callback_user=\"Echo Bot\")\n",
+    "chat_feed = pn.chat.ChatFeed(callback=parrot_message, callback_user=\"Echo Bot\")\n",
     "chat_feed"
    ]
   },
@@ -289,7 +289,7 @@
     "def bad_callback(contents, user, instance):\n",
     "    return 1 / 0\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=bad_callback, callback_exception=\"summary\")\n",
+    "chat_feed = pn.chat.ChatFeed(callback=bad_callback, callback_exception=\"summary\")\n",
     "chat_feed"
    ]
   },
@@ -325,7 +325,7 @@
     "    await asyncio.sleep(2.8)\n",
     "    return {\"value\": f\"No, {contents.lower()}\", \"user\": \"Parrot\", \"avatar\": \"🦜\"}\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=parrot_message, callback_user=\"Echo Bot\")\n",
+    "chat_feed = pn.chat.ChatFeed(callback=parrot_message, callback_user=\"Echo Bot\")\n",
     "chat_feed"
    ]
   },
@@ -361,7 +361,7 @@
     "        message += character\n",
     "        yield message\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=stream_message)\n",
+    "chat_feed = pn.chat.ChatFeed(callback=stream_message)\n",
     "chat_feed"
    ]
   },
@@ -392,7 +392,7 @@
     "        await asyncio.sleep(0.1)\n",
     "        yield character\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=replace_message)\n",
+    "chat_feed = pn.chat.ChatFeed(callback=replace_message)\n",
     "chat_feed"
    ]
   },
@@ -428,7 +428,7 @@
     "        message += chunk[\"choices\"][0][\"delta\"].get(\"content\", \"\")\n",
     "        yield message\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=openai_callback)\n",
+    "chat_feed = pn.chat.ChatFeed(callback=openai_callback)\n",
     "chat_feed.send(\"Have you heard of HoloViz Panel?\")\n",
     "```\n",
     "\n",
@@ -466,7 +466,7 @@
     "        }\n",
     "\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=chain_message)\n",
+    "chat_feed = pn.chat.ChatFeed(callback=chain_message)\n",
     "chat_feed"
    ]
   },
@@ -514,7 +514,7 @@
     "    instance.respond()\n",
     "\n",
     "\n",
-    "chat_feed = pn.widgets.ChatFeed(callback=openai_self_chat, sizing_mode=\"stretch_width\", height=1000).servable()\n",
+    "chat_feed = pn.chat.ChatFeed(callback=openai_self_chat, sizing_mode=\"stretch_width\", height=1000).servable()\n",
     "chat_feed.send(\"What is HoloViz Panel?\")\n",
     "```\n",
     "\n",
@@ -534,7 +534,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chat_feed = pn.widgets.ChatFeed()\n",
+    "chat_feed = pn.chat.ChatFeed()\n",
     "\n",
     "# creates a new entry\n",
     "entry = chat_feed.stream(\"Hello\", user=\"Aspiring User\", avatar=\"🤓\")\n",
@@ -564,7 +564,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chat_feed = pn.widgets.ChatFeed()\n",
+    "chat_feed = pn.chat.ChatFeed()\n",
     "chat_feed"
    ]
   },
@@ -596,7 +596,7 @@
     "entry_params = dict(\n",
     "    default_avatars={\"System\": \"S\", \"User\": \"👤\"}, reaction_icons={\"like\": \"thumb-up\"}\n",
     ")\n",
-    "chat_feed = pn.widgets.ChatFeed(entry_params=entry_params)\n",
+    "chat_feed = pn.chat.ChatFeed(entry_params=entry_params)\n",
     "chat_feed.send(user=\"System\", value=\"This is the System speaking.\")\n",
     "chat_feed.send(user=\"User\", value=\"This is the User speaking.\")\n",
     "chat_feed"
@@ -619,7 +619,7 @@
    "source": [
     "import asyncio\n",
     "import panel as pn\n",
-    "from panel.widgets.chat import ChatEntry, ChatFeed\n",
+    "from panel.chat import ChatEntry, ChatFeed\n",
     "\n",
     "pn.extension()\n",
     "\n",

examples/reference/widgets/ChatInterface.ipynb → examples/reference/chat/ChatInterface.ipynb

@@ -7,7 +7,7 @@
    "outputs": [],
    "source": [
     "import panel as pn\n",
-    "from panel.widgets import ChatInterface\n",
+    "from panel.chat import ChatInterface\n",
     "\n",
     "pn.extension()"
    ]
@@ -275,7 +275,7 @@
     "        instance.active = 0  # Change to TextAreaInput tab\n",
     "    return f\"Got {num}.\"\n",
     "\n",
-    "pn.widgets.ChatInterface(\n",
+    "pn.chat.ChatInterface(\n",
     "    callback=guided_get_num,\n",
     "    widgets=[\n",
     "        pn.widgets.TextAreaInput(placeholder=\"Enter some text to get a count!\"),\n",
@@ -311,7 +311,7 @@
     "    pn.widgets.TextAreaInput(placeholder=\"Enter some text to get a count!\"),\n",
     "    pn.widgets.IntSlider(name=\"Number Input\", end=10)\n",
     "]\n",
-    "pn.widgets.ChatInterface(\n",
+    "pn.chat.ChatInterface(\n",
     "    callback=get_num_guided,\n",
     "    widgets=widgets[0],\n",
     ")"
@@ -334,7 +334,7 @@
     "    pn.widgets.TextAreaInput(placeholder=\"Enter some text to get a count!\"),\n",
     "    pn.widgets.IntSlider(name=\"Number Input\", end=10)\n",
     "]\n",
-    "chat_interface = pn.widgets.ChatInterface(\n",
+    "chat_interface = pn.chat.ChatInterface(\n",
     "    widgets=widgets,\n",
     ")\n",
     "print(chat_interface.active_widget)"
@@ -355,7 +355,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatInterface(\n",
+    "pn.chat.ChatInterface(\n",
     "    widgets=pn.widgets.TextAreaInput(),\n",
     "    reset_on_send=False,\n",
     ")"
@@ -376,7 +376,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatInterface(callback=get_num, show_rerun=False, show_undo=False)"
+    "pn.chat.ChatInterface(callback=get_num, show_rerun=False, show_undo=False)"
    ]
   },
   {
@@ -392,7 +392,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pn.widgets.ChatInterface(callback=get_num, show_button_name=False, width=400)"
+    "pn.chat.ChatInterface(callback=get_num, show_button_name=False, width=400)"
    ]
   }
  ],

panel/__init__.py

@@ -47,6 +47,7 @@
 """
 from param import rx
 
+from . import chat  # noqa
 from . import layout  # noqa
 from . import links  # noqa
 from . import pane  # noqa
@@ -74,6 +75,7 @@
     "__version__",
     "Accordion",
     "Card",
+    "chat",
     "Column",
     "FlexBox",
     "FloatPanel",

panel/chat/__init__.py

@@ -0,0 +1,43 @@
+"""
+Panel chat makes creating chat components easy
+==============================================================
+
+Check out the widget gallery
+https://panel.holoviz.org/reference/index.html#chat for inspiration.
+
+How to use Panel widgets in 3 simple steps
+------------------------------------------
+
+1. Define your function
+
+>>> async def repeat_contents(contents, user, instance):
+>>>     yield contents
+
+2. Define your widgets and callback.
+
+>>> chat_interface = ChatInterface(callback=repeat_contents)
+
+3. Layout the chat interface in a template
+
+>>> template = pn.template.FastListTemplate(
+>>>     title="Panel Chat",
+>>>     main=[chat_interface],
+>>> )
+>>> template.servable()
+
+For more detail see the Reference Gallery guide.
+https://panel.holoviz.org/reference/chat/ChatInterface.html
+"""
+from .entry import ChatEntry  # noqa
+from .feed import ChatFeed  # noqa
+from .icon import ChatReactionIcons  # noqa
+from .interface import ChatInterface  # noqa
+from .langchain import PanelCallbackHandler  # noqa
+
+__all__ = (
+    "ChatEntry",
+    "ChatFeed",
+    "ChatInterface",
+    "ChatReactionIcons",
+    "PanelCallbackHandler",
+)