Support saving chat history in gr.ChatInterface

.changeset/tiny-areas-train.md

@@ -0,0 +1,8 @@
+---
+"@gradio/button": minor
+"@gradio/dataset": minor
+"@gradio/textbox": minor
+"gradio": minor
+---
+
+feat:Support saving chat history in `gr.ChatInterface`

demo/chatinterface_save_history/run.ipynb

@@ -0,0 +1 @@
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: chatinterface_save_history"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "def echo_multimodal(message, history):\n", "    response = \"You wrote: '\" + message[\"text\"] + \"' and uploaded: \" + str(len(message[\"files\"])) + \" files\"\n", "    return response\n", "\n", "demo = gr.ChatInterface(\n", "    echo_multimodal,\n", "    type=\"messages\",\n", "    multimodal=True,\n", "    textbox=gr.MultimodalTextbox(file_count=\"multiple\"),\n", "    save_history=True,\n", ")\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/chatinterface_save_history/run.py

@@ -0,0 +1,16 @@
+import gradio as gr
+
+def echo_multimodal(message, history):
+    response = "You wrote: '" + message["text"] + "' and uploaded: " + str(len(message["files"])) + " files"
+    return response
+
+demo = gr.ChatInterface(
+    echo_multimodal,
+    type="messages",
+    multimodal=True,
+    textbox=gr.MultimodalTextbox(file_count="multiple"),
+    save_history=True,
+)
+
+if __name__ == "__main__":
+    demo.launch()

demo/chatinterface_streaming_echo/run.ipynb

@@ -1 +1 @@
-{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: chatinterface_streaming_echo"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import time\n", "import gradio as gr\n", "\n", "def slow_echo(message, history):\n", "    for i in range(len(message)):\n", "        time.sleep(0.05)\n", "        yield \"You typed: \" + message[: i + 1]\n", "\n", "demo = gr.ChatInterface(slow_echo, type=\"messages\", flagging_mode=\"manual\", flagging_options=[\"Like\", \"Spam\", \"Inappropriate\", \"Other\"])\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: chatinterface_streaming_echo"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import time\n", "import gradio as gr\n", "\n", "def slow_echo(message, history):\n", "    for i in range(len(message)):\n", "        time.sleep(0.05)\n", "        yield \"You typed: \" + message[: i + 1]\n", "\n", "demo = gr.ChatInterface(slow_echo, type=\"messages\", save_history=True)\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/chatinterface_streaming_echo/run.py

@@ -6,7 +6,13 @@ def slow_echo(message, history):
         time.sleep(0.05)
         yield "You typed: " + message[: i + 1]
 
-demo = gr.ChatInterface(slow_echo, type="messages", flagging_mode="manual", flagging_options=["Like", "Spam", "Inappropriate", "Other"])
+demo = gr.ChatInterface(
+    slow_echo,
+    type="messages",
+    flagging_mode="manual",
+    flagging_options=["Like", "Spam", "Inappropriate", "Other"], 
+    save_history=True,
+)
 
 if __name__ == "__main__":
     demo.launch()

gradio/__init__.py

@@ -167,7 +167,6 @@
     "ImageEditor",
     "ImageMask",
     "Info",
-    "Success",
     "Interface",
     "JSON",
     "Json",
@@ -204,6 +203,7 @@
     "Sketchpad",
     "Slider",
     "State",
+    "Success",
     "Tab",
     "TabItem",
     "TabbedInterface",

gradio/components/button.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from collections.abc import Callable, Sequence
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Literal
 
 from gradio_client.documentation import document
@@ -29,8 +30,8 @@ def __init__(
         every: Timer | float | None = None,
         inputs: Component | Sequence[Component] | set[Component] | None = None,
         variant: Literal["primary", "secondary", "stop", "huggingface"] = "secondary",
-        size: Literal["sm", "lg"] | None = None,
-        icon: str | None = None,
+        size: Literal["sm", "md", "lg"] | None = None,
+        icon: str | Path | None = None,
         link: str | None = None,
         visible: bool = True,
         interactive: bool = True,

gradio/components/clear_button.py

@@ -5,6 +5,7 @@
 import copy
 import json
 from collections.abc import Sequence
+from pathlib import Path
 from typing import TYPE_CHECKING, Any, Literal
 
 from gradio_client.documentation import document
@@ -36,8 +37,8 @@ def __init__(
         every: Timer | float | None = None,
         inputs: Component | Sequence[Component] | set[Component] | None = None,
         variant: Literal["primary", "secondary", "stop"] = "secondary",
-        size: Literal["sm", "lg"] | None = None,
-        icon: str | None = None,
+        size: Literal["sm", "md", "lg"] | None = None,
+        icon: str | Path | None = None,
         link: str | None = None,
         visible: bool = True,
         interactive: bool = True,

gradio/components/dataset.py

@@ -29,11 +29,13 @@ def __init__(
         self,
         *,
         label: str | None = None,
+        show_label: bool = True,
         components: Sequence[Component] | list[str] | None = None,
         component_props: list[dict[str, Any]] | None = None,
         samples: list[list[Any]] | None = None,
         headers: list[str] | None = None,
         type: Literal["values", "index", "tuple"] = "values",
+        layout: Literal["gallery", "table"] | None = None,
         samples_per_page: int = 10,
         visible: bool = True,
         elem_id: str | None = None,
@@ -49,10 +51,12 @@ def __init__(
         """
         Parameters:
             label: the label for this component, appears above the component.
+            show_label: If True, the label will be shown above the component.
             components: Which component types to show in this dataset widget, can be passed in as a list of string names or Components instances. The following components are supported in a Dataset: Audio, Checkbox, CheckboxGroup, ColorPicker, Dataframe, Dropdown, File, HTML, Image, Markdown, Model3D, Number, Radio, Slider, Textbox, TimeSeries, Video
             samples: a nested list of samples. Each sublist within the outer list represents a data sample, and each element within the sublist represents an value for each component
             headers: Column headers in the Dataset widget, should be the same len as components. If not provided, inferred from component labels
             type: "values" if clicking on a sample should pass the value of the sample, "index" if it should pass the index of the sample, or "tuple" if it should pass both the index and the value of the sample.
+            layout: "gallery" if the dataset should be displayed as a gallery with each sample in a clickable card, or "table" if it should be displayed as a table with each sample in a row. By default, "gallery" is used if there is a single component, and "table" is used if there are more than one component. If there are more than one component, the layout can only be "table".
             samples_per_page: how many examples to show per page.
             visible: If False, component will be hidden.
             elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
@@ -75,6 +79,8 @@ def __init__(
         self.container = container
         self.scale = scale
         self.min_width = min_width
+        self.layout = layout
+        self.show_label = show_label
         self._components = [get_component_instance(c) for c in components or []]
         if component_props is None:
             self.component_props = [

gradio/components/download_button.py

@@ -37,7 +37,7 @@ def __init__(
         inputs: Component | Sequence[Component] | set[Component] | None = None,
         variant: Literal["primary", "secondary", "stop"] = "secondary",
         visible: bool = True,
-        size: Literal["sm", "lg"] | None = None,
+        size: Literal["sm", "md", "lg"] | None = None,
         icon: str | None = None,
         scale: int | None = None,
         min_width: int | None = None,

gradio/components/duplicate_button.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
+from pathlib import Path
 from typing import TYPE_CHECKING, Literal
 
 from gradio_client.documentation import document
@@ -30,8 +31,8 @@ def __init__(
         every: Timer | float | None = None,
         inputs: Component | Sequence[Component] | set[Component] | None = None,
         variant: Literal["primary", "secondary", "stop", "huggingface"] = "huggingface",
-        size: Literal["sm", "lg"] | None = "sm",
-        icon: str | None = None,
+        size: Literal["sm", "md", "lg"] | None = "sm",
+        icon: str | Path | None = None,
         link: str | None = None,
         visible: bool = True,
         interactive: bool = True,

gradio/components/login_button.py

@@ -6,10 +6,12 @@
 import time
 import warnings
 from collections.abc import Sequence
+from pathlib import Path
 from typing import TYPE_CHECKING, Literal
 
 from gradio_client.documentation import document
 
+from gradio import utils
 from gradio.components import Button, Component
 from gradio.context import get_blocks_context
 from gradio.routes import Request
@@ -34,9 +36,8 @@ def __init__(
         every: Timer | float | None = None,
         inputs: Component | Sequence[Component] | set[Component] | None = None,
         variant: Literal["primary", "secondary", "stop", "huggingface"] = "huggingface",
-        size: Literal["sm", "lg"] | None = None,
-        icon: str
-        | None = "https://huggingface.co/front/assets/huggingface_logo-noborder.svg",
+        size: Literal["sm", "md", "lg"] | None = None,
+        icon: str | Path | None = utils.get_icon_path("huggingface-logo.svg"),
         link: str | None = None,
         visible: bool = True,
         interactive: bool = True,

gradio/icons/README.md

@@ -0,0 +1,2 @@
+The icons in this directory are loaded via `gradio.utils.get_icon_path` and
+can be used directly in backend code (e.g. to populate icons in components).

gradio/themes/base.py

@@ -708,6 +708,10 @@ def set(
         button_small_radius=None,
         button_small_text_size=None,
         button_small_text_weight=None,
+        button_medium_padding=None,
+        button_medium_radius=None,
+        button_medium_text_size=None,
+        button_medium_text_weight=None,
         button_primary_background_fill=None,
         button_primary_background_fill_dark=None,
         button_primary_background_fill_hover=None,
@@ -1006,6 +1010,10 @@ def set(
             button_small_radius: The corner radius of a button set to "small" size.
             button_small_text_size: The text size of a button set to "small" size.
             button_small_text_weight: The text weight of a button set to "small" size.
+            button_medium_padding: The padding of a button set to "medium" size.
+            button_medium_radius: The corner radius of a button set to "medium" size.
+            button_medium_text_size: The text size of a button set to "medium" size.
+            button_medium_text_weight: The text weight of a button set to "medium" size.
             button_transition: The transition animation duration of a button between regular, hover, and focused states.
             button_transform_hover: The transform animation of a button on hover.
             button_transform_active: The transform animation of a button when pressed.
@@ -1956,5 +1964,17 @@ def set(
         self.button_small_text_weight = button_small_text_weight or getattr(
             self, "button_small_text_weight", "400"
         )
+        self.button_medium_padding = button_medium_padding or getattr(
+            self, "button_medium_padding", "*spacing_md calc(2 * *spacing_md)"
+        )
+        self.button_medium_radius = button_medium_radius or getattr(
+            self, "button_medium_radius", "*radius_md"
+        )
+        self.button_medium_text_size = button_medium_text_size or getattr(
+            self, "button_medium_text_size", "*text_md"
+        )
+        self.button_medium_text_weight = button_medium_text_weight or getattr(
+            self, "button_medium_text_weight", "600"
+        )
 
         return self