Support saving chat history in `gr.ChatInterface` #10191

abidlabs · 2024-12-13T00:40:22Z

Test with: demo/chatinterface_save_history/run.py

gradio-pr-bot · 2024-12-13T00:41:04Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
	Storybook	ready!	Storybook preview
🦄	Changes	detected!	Details

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/abb8a8ea7405c25ee8f3c337cba8c11d6a5bd167/gradio-5.9.1-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@abb8a8ea7405c25ee8f3c337cba8c11d6a5bd167#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/abb8a8ea7405c25ee8f3c337cba8c11d6a5bd167/gradio-client-1.8.0.tgz

Use Lite from this PR

<script type="module" src="https://gradio-lite-previews.s3.amazonaws.com/abb8a8ea7405c25ee8f3c337cba8c11d6a5bd167/dist/lite.js""></script>

gradio-pr-bot · 2024-12-13T00:41:17Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`@gradio/button`	`minor`
`@gradio/dataset`	`minor`
`@gradio/textbox`	`minor`
`gradio`	`minor`

Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Support saving chat history in gr.ChatInterface

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

Maintainers can change the version label to modify the version bump.
If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

dawoodkhan82 · 2024-12-23T06:20:35Z

@abidlabs I'll replace gr.State() here with gr.BrowserState(), and update the styling of the html "sidebar". Is that what you had in mind?

abidlabs · 2024-12-23T11:17:38Z

Yes exactly. We also need to actually save the chat history to the browser state, that functionality is currently not implemented

abidlabs · 2024-12-23T21:58:14Z

You may find this PR useful: #10245 (or maybe not, not sure)

* Declare exports * add changeset * type fixes * more type fixes * add changeset * notebooks * changes --------- Co-authored-by: gradio-pr-bot <[email protected]> Co-authored-by: Freddy Boulton <[email protected]> Co-authored-by: Abubakar Abid <[email protected]>

* changes * changes * add changeset * format * changes --------- Co-authored-by: gradio-pr-bot <[email protected]>

dawoodkhan82 · 2024-12-27T00:30:52Z

@abidlabs Did a first pass, and the functionality for chat conversation history should work, if you can test. Will push some changes to tweak the UI.

abidlabs · 2024-12-27T03:28:21Z

Will take a look soon!

abidlabs · 2024-12-27T04:32:00Z

Nice @dawoodkhan82! Core functionality to save to browser state is working for me and I like that the first message automatically becomes the title of the saved first chat. Some issues I noticed:

(1) Clicking on the trash button in Chatbot causes the history to error out. And in a permanent way: if you refresh the page, you'll see that none of the chats in the history remain and you actually need to restart the Gradio server to get the chat history working again:

Screen.Recording.2024-12-26.at.11.26.28.PM.mov

(2) Uploading an image breaks the chat history feature as well:

Screen.Recording.2024-12-26.at.11.27.45.PM.mov

(3) When you load the chat from the history, its not synchronized with the chat state, so that if you send a subsequent message, it wipes out the chat history instead of "resuming" from the last message:

Screen.Recording.2024-12-26.at.11.29.40.PM.mov

(4) Also, the final chat that is stored to history seems to be used as the value for all of the chats. So if you click through the chats, all of them will have the same value actually:

Screen.Recording.2024-12-26.at.11.31.17.PM.mov

…-history

abidlabs · 2024-12-30T16:50:07Z

Fixed isseus (3) and (4), working on the others

abidlabs · 2024-12-30T19:01:30Z

There are some edge cases I need to fix (e.g. handling images and other non-text messages) but let me open for feedback, especially on the design side

abidlabs · 2024-12-31T18:13:24Z

Ok I've replaced everything with native Gradio components and I agree it looks a lot better, thanks @aliabid94 for the suggestion so it should be ready for a re-review:

Screen.Recording.2024-12-31.at.1.12.10.PM.mov

Btw I've made some changes to some other gradio components, which I'll explain below

abidlabs · 2024-12-31T18:13:59Z

gradio/components/button.py

@@ -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,


I added a "md"-sized button as that was ideal for this UI and I think it could be more broadly useful.

Made the same change to all of the subclasses of Button below

abidlabs · 2024-12-31T18:15:47Z

gradio/components/dataset.py

            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".


I added some parameters to gr.Dataset that are broadly useful. For example, this one comes up a lot.

abidlabs · 2024-12-31T18:16:49Z

gradio/components/login_button.py

-        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"),


So that this works offline

abidlabs · 2024-12-31T18:17:38Z

gradio/utils.py

@@ -1098,7 +1098,7 @@ def is_in_or_equal(path_1: str | Path, path_2: str | Path) -> bool:


 @document()
-def set_static_paths(paths: list[str | Path]) -> None:
+def set_static_paths(paths: str | Path | list[str | Path]) -> list[str | Path]:


Its safer to accept a str explicitly because otherwise if a user passes in a str accidentally, every individual character will be treated as a separate "file"

gradio/utils.py

abidlabs · 2024-12-31T18:30:06Z

js/spa/test/test_chatinterface_streaming_echo.spec.ts

 		await expect(page.locator("#num-recorded-api-calls")).toContainText(
-			`🪄 Recorded API Calls [${n_calls}]`


n_calls is an implementation detail

…-history

This reverts commit 13bfe8c.

save history prototype

b6bca34

abidlabs marked this pull request as draft December 13, 2024 00:40

add changeset

a846b38

merge

d8d64bc

abidlabs and others added 5 commits December 23, 2024 16:58

Merge branch 'main' into chat-history

dfd3ad5

Add gr.BrowserState change event (#10245)

bcd383e

* changes * changes * add changeset * format * changes --------- Co-authored-by: gradio-pr-bot <[email protected]>

history

a1e0bd1

Merge branch 'main' into chat-history

02caf94

abidlabs force-pushed the chat-history branch from 02caf94 to bcd383e Compare December 30, 2024 15:26

abidlabs added 6 commits December 30, 2024 10:27

Merge branch 'main' into chat-history

8ace831

Merge branch 'chat-history' of github.com:gradio-app/gradio into chat…

be531b6

…-history

changes

caccb0b

changes

9251dea

changes

08e6615

history

3cdb67b

abidlabs added 4 commits December 30, 2024 13:45

changes

c20ceda

changes

8438764

changes

269ff00

format

5477552

abidlabs added 4 commits December 31, 2024 13:02

changes

7c4a8e3

changes

af6523e

changes

037b1e9

fix

ded0b3d

abidlabs commented Dec 31, 2024

View reviewed changes

gradio/utils.py Outdated Show resolved Hide resolved

fix tests

7cbc66f

abidlabs commented Dec 31, 2024

View reviewed changes

abidlabs and others added 18 commits December 31, 2024 15:50

change

37f4a84

add changeset

6e90ca3

fix logo issue

bff664e

Merge branch 'chat-history' of github.com:gradio-app/gradio into chat…

0ec7f25

…-history

changes

6842fa5

version

5052e5d

add changeset

791deca

fix typecheck

59bcf92

Merge branch 'chat-history' of github.com:gradio-app/gradio into chat…

67770ec

…-history

remove redundant

ddbe6a8

pkg version

92e905e

add changeset

9075df8

changes

13bfe8c

Merge branch 'chat-history' of github.com:gradio-app/gradio into chat…

42a4333

…-history

Revert "changes"

32bed0d

This reverts commit 13bfe8c.

reorganize code

48093c1

format

edeb035

changes

abb8a8e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support saving chat history in `gr.ChatInterface` #10191

Support saving chat history in `gr.ChatInterface` #10191

abidlabs commented Dec 13, 2024 •

edited

Loading

gradio-pr-bot commented Dec 13, 2024 •

edited

Loading

gradio-pr-bot commented Dec 13, 2024 •

edited

Loading

Something isn't right?

dawoodkhan82 commented Dec 23, 2024

abidlabs commented Dec 23, 2024

abidlabs commented Dec 23, 2024

dawoodkhan82 commented Dec 27, 2024

abidlabs commented Dec 27, 2024

abidlabs commented Dec 27, 2024

abidlabs commented Dec 30, 2024

abidlabs commented Dec 30, 2024

abidlabs commented Dec 31, 2024

abidlabs Dec 31, 2024

abidlabs Dec 31, 2024

abidlabs Dec 31, 2024

abidlabs Dec 31, 2024

abidlabs Dec 31, 2024

abidlabs Dec 31, 2024

		await expect(page.locator("#num-recorded-api-calls")).toContainText(
		`🪄 Recorded API Calls [${n_calls}]`

Support saving chat history in gr.ChatInterface #10191

Are you sure you want to change the base?

Support saving chat history in gr.ChatInterface #10191

Conversation

abidlabs commented Dec 13, 2024 • edited Loading

gradio-pr-bot commented Dec 13, 2024 • edited Loading

🪼 branch checks and previews

gradio-pr-bot commented Dec 13, 2024 • edited Loading

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

dawoodkhan82 commented Dec 23, 2024

abidlabs commented Dec 23, 2024

abidlabs commented Dec 23, 2024

dawoodkhan82 commented Dec 27, 2024

abidlabs commented Dec 27, 2024

abidlabs commented Dec 27, 2024

abidlabs commented Dec 30, 2024

abidlabs commented Dec 30, 2024

abidlabs commented Dec 31, 2024

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

abidlabs Dec 31, 2024

Choose a reason for hiding this comment

Support saving chat history in `gr.ChatInterface` #10191

Support saving chat history in `gr.ChatInterface` #10191

abidlabs commented Dec 13, 2024 •

edited

Loading

gradio-pr-bot commented Dec 13, 2024 •

edited

Loading

gradio-pr-bot commented Dec 13, 2024 •

edited

Loading