adds a run_examples_on_click parameter to gr.ChatInterface mirroring the the run_on_click parameter in gr.Examples

[abidlabs]

Small PR that adds a run_examples_on_click parameter on to gr.ChatInterface, closes: #10103

Two examples to test with:

import gradio as gr

def echo(message, history):
    return message["text"]

demo = gr.ChatInterface(
    fn=echo,
    type="messages",
    examples=[{"text": "abc"}, {"text": "hello", "files": ["files/avatar.png"]}, {"text": "hola", "files": ["files/cantina.wav"]}],
    title="Echo Bot",
    multimodal=True,
    run_examples_on_click=False,
)
demo.launch()

import random
import gradio as gr

def random_response(message, history):
    return random.choice(["Yes", "No"])

demo = gr.ChatInterface(random_response, type="messages", autofocus=False, run_examples_on_click=False, examples=["Hello", "Hi", "How are you?", "I am fine", "Thank you"])

if __name__ == "__main__":
    demo.launch()

Also fixes: #10105

[gradio-pr-bot]

🪼 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/43acdc2c90952f63fb8f7ccc6122a1615def004a/gradio-5.8.0-py3-none-any.whl

Install Gradio Python Client from this PR

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

Install Gradio JS Client from this PR

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

Use Lite from this PR

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

[gradio-pr-bot]

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
gradio	minor
website	minor

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

With the following changelog entry.

adds a run_examples_on_click parameter to gr.ChatInterface mirroring the the run_on_click parameter in gr.Examples

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.

[freddyaboulton]

If run_on_click=True, then images in the multimodal textbox are not displayed as images in the chatbot:

This is not the case when run_on_click=False

other than that LGTM!

[abidlabs]

Thanks yet again @freddyaboulton! Will take a look at that issue

[abidlabs]

Oh so the issue is actually with the default behavior hmm

[abidlabs]

Noticed another issue, which is that when cache_examples=True, any cached files appear on the wrong side of the chatbot:

import gradio as gr

def echo(message, history):
    return message["text"]

demo = gr.ChatInterface(
    fn=echo,
    type="messages",
    examples=[{"text": "hello", "files":["files/avatar.png"]}, {"text": "hola"}, {"text": "merhaba"}],
    cache_examples=True,
    title="Echo Bot",
    multimodal=True,
)
demo.launch()

[hysts]

Thanks! Basically LGTM, but I noticed that the undo button is not working correctly for multimodal examples run_examples_on_click=True. Looks like it was broken from the beginning.

out.mp4

[abidlabs]

Dang okay thanks for flagging @hysts!

[hysts]

As the undo issue is not introduced in this PR, I guess it can be fixed in another PR. So I'll approve this PR for now.

[abidlabs]

Let me see if I can fix it real quick

[abidlabs]

Fixed the undo bug and added two more end-to-end tests to test. We've added quite a few e2e tests for chatinterface, but I think we need them all since there are so many different message types and configuration paths. When we have bandwidth, we can figure out ways to run them faster.

[abidlabs]

Thanks @freddyaboulton and @hysts for the thorough reviews, I'll merge this in when CI is green.

[abidlabs]

😅 taking a bit longer than I thought but doing some secondary cleanup as well

[abidlabs]

Whew finally ready. Will merge this in tomorrow if there are no objections!