Gradio 的用户月活突破 100 万!

阅读更多
Gradio logo
  1. 组件
  2. 聊天机器人

Gradio 新手?从这里开始: 入门指南

查看发布历史

聊天机器人

gradio.Chatbot(type="messages", ···)
import gradio as gr with gr.Blocks() as demo: gr.Chatbot(value=[ {"role": "user", "content": "Hello World"}, {"role": "assistant", "content": "Hey Gradio!"}, {"role": "user", "content": "❤️"}, {"role": "assistant", "content": "😍"} ], type="messages") demo.launch()

描述

创建一个聊天机器人,用于显示用户提交的消息和回复。支持 Markdown 的子集,包括粗体、斜体、代码、表格。还支持音频/视频/图像文件,这些文件会显示在聊天机器人中,以及其他类型的文件,这些文件会显示为链接。此组件通常用作输出组件。

行为

聊天机器人接受的数据格式由 type 参数决定。此参数可以接受两个值:'tuples''messages''tuples' 类型已弃用,将在 Gradio 的未来版本中移除。

消息格式

如果 type'messages',则发送到聊天机器人/从聊天机器人发送的数据将是一个字典列表,其中包含 rolecontent 键。此格式符合大多数 LLM API(HuggingChat、OpenAI、Claude)期望的格式。 role 键为 'user''assistant'content 键可以是以下内容之一:应为字符串(呈现为 markdown/html)或 Gradio 组件(用于显示文件)。

例如

import gradio as gr

history = [
    {"role": "assistant", "content": "I am happy to provide you that report and plot."},
    {"role": "assistant", "content": gr.Plot(value=make_plot_from_file('quaterly_sales.txt'))}
]

with gr.Blocks() as demo:
    gr.Chatbot(history, type="messages")

demo.launch()

为了方便起见,您可以使用 ChatMessage 数据类,以便您的文本编辑器可以为您提供自动完成提示和类型检查。

import gradio as gr

history = [
    gr.ChatMessage(role="assistant", content="How can I help you?"),
    gr.ChatMessage(role="user", content="Can you make me a plot of quarterly sales?"),
    gr.ChatMessage(role="assistant", content="I am happy to provide you that report and plot.")
]

with gr.Blocks() as demo:
    gr.Chatbot(history, type="messages")

demo.launch()

初始化

参数
🔗
value: list[MessageDict | Message] | TupleFormat | Callable | None
default = None

要在聊天机器人中显示的默认消息列表,其中每条消息的格式为 {"role": "user", "content": "Help me."}。“角色”可以是“用户”、“助手”或“系统”之一。“内容”应为文本,或作为 Gradio 组件传递的媒体,例如 {"content": gr.Image("lion.jpg")}。如果提供了函数,则每次加载应用程序时都会调用该函数以设置此组件的初始值。

🔗
type: Literal['messages', 'tuples'] | None
default = None

传递到 `fn` 的聊天历史记录参数中的消息格式。如果为“messages”,则将值作为字典列表传递,其中包含 openai 样式的“role”和“content”键。“content”键的值应为以下之一 - (1) 有效 Markdown 格式的字符串 (2) 包含“path”键和与要显示的文件对应的值的字典,或 (3) Gradio 组件的实例。目前支持 Image、Plot、Video、Gallery、Audio 和 HTML。“role”键应为“user”或“assistant”之一。任何其他角色都不会显示在输出中。如果此参数为“tuples”,则应为 `list[list[str | None | tuple]]`,即列表的列表。内部列表应包含 2 个元素:用户消息和回复消息,但此格式已弃用。

🔗
label: str | None
default = None

此组件的标签。显示在组件上方,如果此组件有示例表,则也用作标题。如果为 None 且在 `gr.Interface` 中使用,则标签将为此组件分配到的参数的名称。

🔗
every: Timer | float | None
default = None

如果 `value` 是函数,则持续调用 `value` 以重新计算它(否则无效)。可以提供一个 Timer,其刻度重置 `value`,或者提供一个浮点数,以提供重置 Timer 的常规间隔。

🔗
inputs: Component | list[Component] | set[Component] | None
default = None

用作计算 `value` 的输入的组件(如果 `value` 是函数,则无效)。每当输入发生更改时,都会重新计算 `value`。

🔗
show_label: bool | None
default = None

如果为 True,将显示标签。

🔗
container: bool
default = True

如果为 True,则将组件放在容器中 - 在边框周围提供一些额外的填充。

🔗
scale: int | None
default = None

与相邻组件相比的相对大小。例如,如果组件 A 和 B 在同一行中,并且 A 的 scale=2,B 的 scale=1,则 A 的宽度将是 B 的两倍。应为整数。scale 应用于行,以及 Blocks 中 fill_height=True 的顶级组件。

🔗
min_width: int
default = 160

最小像素宽度,如果屏幕空间不足以满足此值,则会换行。如果某个 scale 值导致此组件的宽度小于 min_width,则将首先遵循 min_width 参数。

🔗
visible: bool
default = True

如果为 False,组件将被隐藏。

🔗
elem_id: str | None
default = None

一个可选的字符串,用作此组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗
elem_classes: list[str] | str | None
default = None

一个可选的字符串列表,用作此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗
autoscroll: bool
default = True

如果为 True,则当值更改时,将自动滚动到文本框的底部,除非用户向上滚动。如果为 False,则当值更改时,不会滚动到文本框的底部。

🔗
render: bool
default = True

如果为 False,组件将不会在 Blocks 上下文中呈现。如果目的是现在分配事件侦听器,但稍后呈现组件,则应使用此选项。

🔗
key: int | str | None
default = None

如果已分配,将用于在重新渲染时假定身份。在重新渲染中具有相同键的组件将保留其值。

🔗
height: int | str | None
default = 400

组件的高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。如果消息超出高度,组件将滚动。

🔗
resizable: bool
default = False

如果为 True,Gradio 应用程序的用户可以通过拖动右下角来调整聊天机器人的大小。

🔗
resizeable: bool
default = False
🔗
max_height: int | str | None
default = None

组件的最大高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。如果消息超出高度,组件将滚动。如果消息短于高度,组件将缩小以适应内容。如果设置了 `height` 并且小于 `max_height`,则无效。

🔗
min_height: int | str | None
default = None

组件的最小高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。如果消息超出高度,组件将展开以适应内容。如果设置了 `height` 并且大于 `min_height`,则无效。

🔗
editable: Literal['user', 'all'] | None
default = None

允许用户编辑聊天机器人中的消息。如果设置为“user”,则允许编辑用户消息。如果设置为“all”,则也允许编辑助手消息。

🔗
latex_delimiters: list[dict[str, str | bool]] | None
default = None

一个字典列表,格式为 {"left": open delimiter (str), "right": close delimiter (str), "display": whether to display in newline (bool)},将用于呈现 LaTeX 表达式。如果未提供,则 `latex_delimiters` 设置为 `[{ "left": "$$", "right": "$$", "display": True }]`,因此只有用 $$ 分隔符括起来的表达式才会呈现为 LaTeX,并在新行中显示。传入一个空列表以禁用 LaTeX 渲染。有关更多信息,请参阅 KaTeX 文档

🔗
rtl: bool
default = False

如果为 True,则将呈现文本的方向设置为从右到左。默认为 False,这会将文本从左到右呈现。

🔗
show_share_button: bool | None
default = None

如果为 True,将在组件的角上显示一个共享图标,允许用户将输出共享到 Hugging Face Spaces Discussions。如果为 False,则不显示图标。如果设置为 None(默认行为),则如果此 Gradio 应用程序在 Spaces 上启动,则会显示图标,否则不会显示。

🔗
show_copy_button: bool
default = False

如果为 True,将为每条聊天机器人消息显示一个复制按钮。

🔗
watermark: str | None
default = None

如果提供,此文本将附加到从聊天机器人复制的消息末尾,在空行之后。用于指示消息是由 AI 模型生成的,这很有用。

🔗
avatar_images: tuple[str | Path | None, str | Path | None] | None
default = None

用户和机器人的两个头像图像路径或 URL 的元组(按顺序)。为用户或机器人图像传递 None 以跳过。必须在 Gradio 应用程序的工作目录或外部 URL 中。

🔗
sanitize_html: bool
default = True

如果为 False,将禁用聊天机器人消息的 HTML 清理。不建议这样做,因为它可能导致安全漏洞。

🔗
render_markdown: bool
default = True

如果为 False,将禁用聊天机器人消息的 Markdown 渲染。

🔗
feedback_options: list[str] | tuple[str, ...] | None
default = ('Like', 'Dislike')

表示将向用户显示的反馈选项的字符串列表。区分大小写的字符串“Like”和“Dislike”将呈现为拇指图标,但任何其他选择都将显示在单独的标记图标下。

🔗
feedback_value: list[str | None] | None
default = None

表示整个聊天的反馈状态的字符串列表。仅在 type="messages" 时有效。列表中的每个条目都按顺序对应于该助手消息,值是给定的反馈(例如“Like”、“Dislike”或任何自定义反馈选项),如果没有为该消息提供反馈,则为 None。

🔗
bubble_full_width: <class 'inspect._empty'>
default = None

已弃用。

🔗
line_breaks: bool
default = True

如果为 True(默认值),则在聊天机器人消息中启用 Github 风格的 Markdown 换行符。如果为 False,则会忽略单个换行符。仅在 `render_markdown` 为 True 时适用。

🔗
layout: Literal['panel', 'bubble'] | None
default = None

如果为“panel”,则将聊天机器人显示在 llm 样式布局中。如果为“bubble”,则将聊天机器人与消息气泡一起显示,用户和机器人消息在交替的侧面。默认为“bubble”。

🔗
placeholder: str | None
default = None

当聊天机器人为空时,要在聊天机器人中显示的占位符消息。在聊天机器人中垂直和水平居中。支持 Markdown 和 HTML。如果为 None,则不显示占位符。

🔗
examples: list[ExampleMessage] | None
default = None

要在显示任何用户/助手消息之前在聊天机器人中显示的示例消息列表。每个示例都应是一个字典,其中包含一个可选的“text”键,表示单击时应在聊天机器人中填充的消息;一个可选的“files”键,其值应是要在聊天机器人中填充的文件列表;一个可选的“icon”键,其值应是图像的文件路径或 URL,以在示例框中显示;以及一个可选的“display_text”键,其值应是在示例框中显示的文本。如果未提供“display_text”,则将显示“text”的值。

🔗
show_copy_all_button: <class 'inspect._empty'>
default = False

如果为 True,将显示一个复制全部按钮,该按钮将所有聊天机器人消息复制到剪贴板。

🔗
allow_file_downloads: <class 'inspect._empty'>
default = True

如果为 True,将为包含媒体的聊天机器人消息显示一个下载按钮。默认为 True。

🔗
group_consecutive_messages: bool
default = True

如果为 True,则将来自同一角色的连续消息显示在同一气泡中。如果为 False,则将每条消息显示在单独的气泡中。默认为 True。

🔗
allow_tags: list[str] | bool
default = False

如果提供了标签列表,即使 `sanitize_html` 为 `True`,这些标签也会保留在输出聊天机器人消息中。例如,如果此列表为 ["thinking"],则标签 `<thinking>` 和 `</thinking>` 将不会被删除。如果为 True,则将保留所有自定义标签(非标准 HTML 标签)。如果为 False,则不会保留任何标签(默认行为)。

快捷键

Interface 字符串快捷方式 初始化

gradio.Chatbot

"chatbot"

使用默认值

示例

显示想法/工具使用情况

typemessages 时,您可以提供有关用于生成响应的任何工具的其他元数据。这对于显示 LLM 代理的思考过程很有用。例如,

def generate_response(history):
    history.append(
        ChatMessage(role="assistant",
                    content="The weather API says it is 20 degrees Celcius in New York.",
                    metadata={"title": "🛠️ Used tool Weather API"})
        )
    return history

将显示如下

Gradio chatbot tool display

您还可以使用纯 Python 字典指定元数据,

def generate_response(history):
    history.append(
        dict(role="assistant",
             content="The weather API says it is 20 degrees Celcius in New York.",
             metadata={"title": "🛠️ Used tool Weather API"})
        )
    return history

gr.Chatbot 中使用 Gradio 组件

Chatbot 组件支持在聊天机器人内部使用许多核心 Gradio 组件(例如 gr.Imagegr.Plotgr.Audiogr.HTML)。只需在您的元组列表中包含其中一个组件即可。这是一个示例

import gradio as gr

def load():
    return [
        ("Here's an audio", gr.Audio("https://github.com/gradio-app/gradio/raw/main/test/test_files/audio_sample.wav")),
        ("Here's an video", gr.Video("https://github.com/gradio-app/gradio/raw/main/demo/video_component/files/world.mp4"))
    ]

with gr.Blocks() as demo:
    chatbot = gr.Chatbot()
    button = gr.Button("Load audio and video")
    button.click(load, None, chatbot)

demo.launch()

演示

import gradio as gr
import random
import time

with gr.Blocks() as demo:
    chatbot = gr.Chatbot(type="messages")
    msg = gr.Textbox()
    clear = gr.ClearButton([msg, chatbot])

    def respond(message, chat_history):
        bot_message = random.choice(["How are you?", "Today is a great day", "I'm very hungry"])
        chat_history.append({"role": "user", "content": message})
        chat_history.append({"role": "assistant", "content": bot_message})
        time.sleep(2)
        return "", chat_history

    msg.submit(respond, [msg, chatbot], [msg, chatbot])

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

		

事件监听器

描述

事件监听器允许您响应用户与您在 Gradio Blocks 应用程序中定义的 UI 组件的交互。当用户与元素交互时,例如更改滑块值或上传图像,将调用一个函数。

支持的事件监听器

Chatbot 组件支持以下事件监听器。每个事件监听器都接受相同的参数,这些参数在下面的事件参数表中列出。

监听器 描述

Chatbot.change(fn, ···)

当 Chatbot 的值发生变化时触发,原因可能是用户输入(例如,用户在文本框中键入内容)或函数更新(例如,图像从事件触发器的输出接收到一个值)。有关仅由用户输入触发的监听器,请参阅 .input()

Chatbot.select(fn, ···)

当用户选择或取消选择 Chatbot 时的事件监听器。使用事件数据 gradio.SelectData 来传递 value(指 Chatbot 的标签)和 selected(指 Chatbot 的状态)。有关如何使用此事件数据,请参阅 EventData 文档

Chatbot.like(fn, ···)

当用户在 Chatbot 内点赞/踩时触发此监听器。此事件具有 gradio.LikeData 类型的 EventData,其中包含可通过 LikeData.index 和 LikeData.value 访问的信息。有关如何使用此事件数据,请参阅 EventData 文档。

Chatbot.retry(fn, ···)

当用户单击聊天机器人消息中的重试按钮时触发此监听器。

Chatbot.undo(fn, ···)

当用户单击聊天机器人消息中的撤消按钮时触发此监听器。

Chatbot.example_select(fn, ···)

当用户单击 Chatbot 内的示例时触发此监听器。此事件具有 gradio.SelectData 类型的 SelectData,其中包含可通过 SelectData.index 和 SelectData.value 访问的信息。有关如何使用此事件数据,请参阅 SelectData 文档。

Chatbot.option_select(fn, ···)

当用户单击 Chatbot 内的选项时触发此监听器。此事件具有 gradio.SelectData 类型的 SelectData,其中包含可通过 SelectData.index 和 SelectData.value 访问的信息。有关如何使用此事件数据,请参阅 SelectData 文档。

Chatbot.clear(fn, ···)

当用户使用组件的清除按钮清除 Chatbot 时触发此监听器。

Chatbot.copy(fn, ···)

当用户从 Chatbot 复制内容时触发此监听器。使用事件数据 gradio.CopyData 来携带有关复制内容的信息。有关如何使用此事件数据,请参阅 EventData 文档

Chatbot.edit(fn, ···)

当用户使用内置编辑器编辑 Chatbot(例如,图像)时触发此监听器。

事件参数

参数
🔗
fn: Callable | None | Literal['decorator']
default = "decorator"

当此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件,函数应返回单个值或值元组,元组中的每个元素对应一个输出组件。

🔗
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

要用作输入的 gradio.components 列表。如果函数不接受任何输入,则应为空列表。

🔗
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

要用作输出的 gradio.components 列表。如果函数不返回任何输出,则应为空列表。

🔗
api_name: str | None | Literal[False]
default = None

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串,则端点将在 API 文档中公开,并带有给定的名称。如果为 None(默认值),则函数的名称将用作 API 端点。如果为 False,则端点将不会在 API 文档中公开,下游应用程序(包括 `gr.load` 此应用程序的应用程序)将无法使用此事件。

🔗
scroll_to_output: bool
default = False

如果为 True,将在完成后滚动到输出组件

🔗
show_progress: Literal['full', 'minimal', 'hidden']
default = "full"

在事件运行时如何显示进度动画:“full”显示一个覆盖输出组件区域的微调器以及右上角的运行时显示,“minimal”仅显示运行时显示,“hidden”不显示任何进度动画

🔗
show_progress_on: Component | list[Component] | None
default = None

要在其上显示进度动画的组件或组件列表。如果为 None,将在所有输出组件上显示进度动画。

🔗
queue: bool
default = True

如果为 True,则会将请求放在队列中(如果已启用队列)。如果为 False,即使已启用队列,也不会将此事件放入队列中。如果为 None,将使用 Gradio 应用程序的队列设置。

🔗
batch: bool
default = False

如果为 True,则函数应处理一批输入,这意味着它应接受每个参数的输入值列表。列表的长度应相等(且长度最多为 `max_batch_size`)。然后*需要*函数返回一个列表元组(即使只有一个输出组件),元组中的每个列表对应一个输出组件。

🔗
max_batch_size: int
default = 4

如果从队列中调用此函数,则要批量处理的最大输入数(仅在 batch=True 时相关)

🔗
preprocess: bool
default = True

如果为 False,则在运行 'fn' 之前不会运行组件数据的预处理(例如,如果使用 `Image` 组件调用此方法,则将其保留为 base64 字符串)。

🔗
postprocess: bool
default = True

如果为 False,则在将 'fn' 输出返回到浏览器之前,不会运行组件数据的后处理。

🔗
cancels: dict[str, Any] | list[dict[str, Any]] | None
default = None

当此监听器触发时要取消的其他事件列表。例如,设置 cancels=[click_event] 将取消 click_event,其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数(或正在迭代的生成器)将被取消,但当前正在运行的函数将被允许完成。

🔗
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default = None

如果为 “once”(除 `.change()` 之外的所有事件的默认值),则在事件挂起期间不允许任何提交。如果设置为 “multiple”,则在挂起期间允许无限次提交,而 “always_last”(`.change()` 和 `.key_up()` 事件的默认值)将在挂起事件完成后允许第二次提交。

🔗
js: str | Literal[True] | None
default = None

在运行 'fn' 之前要运行的可选前端 js 方法。js 方法的输入参数是 'inputs' 和 'outputs' 的值,返回值应为输出组件的值列表。

🔗
concurrency_limit: int | None | Literal['default']
default = "default"

如果设置,这是可以同时运行的此事件的最大数量。可以设置为 None 表示没有 concurrency_limit(可以同时运行任意数量的此事件)。设置为 “default” 以使用默认并发限制(由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义,该参数本身默认为 1)。

🔗
concurrency_id: str | None
default = None

如果设置,这是并发组的 ID。具有相同 concurrency_id 的事件将受到最低设置 concurrency_limit 的限制。

🔗
show_api: bool
default = True

是否在 Gradio 应用程序的“查看 API”页面或 Gradio 客户端的 “.view_api()” 方法中显示此事件。与将 api_name 设置为 False 不同,将 show_api 设置为 False 仍将允许下游应用程序以及客户端使用此事件。如果 fn 为 None,show_api 将自动设置为 False。

🔗
time_limit: int | None
default = None
🔗
stream_every: float
default = 0.5
🔗
like_user_message: bool
default = False

辅助类

ChatMessage

gradio.ChatMessage(···)

描述

一个数据类,表示 Chatbot 组件(类型为“messages”)中的消息。唯一必需的字段是 contentgr.Chatbot 的值是这些数据类的列表。

参数
🔗
content: str | FileData | Component | FileDataDict | tuple | list

消息的内容。可以是字符串或 Gradio 组件。

🔗
role: Literal['user', 'assistant', 'system']
default = "assistant"

消息的角色,它决定了消息在聊天机器人中的对齐方式。可以是“user”、“assistant”或“system”。默认为 “assistant”。

🔗
metadata: MetadataDict
default = _HAS_DEFAULT_FACTORY_CLASS()

消息的元数据,用于显示中间思考/工具使用情况。应为包含以下键的字典:“title”(显示思考的必需项),以及可选的:“id”和“parent_id”(用于嵌套思考),“duration”(用于显示思考的持续时间),“status”(用于显示思考的状态)。

🔗
options: list[OptionDict]
default = _HAS_DEFAULT_FACTORY_CLASS()

消息的选项。Option 对象的列表,Option 对象是包含以下键的字典:“label”(选项中显示的文本),以及可选的 “value”(如果与标签不同,则在选择选项时返回的值)。

MetadataDict

一个类型化的字典,用于表示 Chatbot 组件中消息的元数据。当聊天消息应显示为思考时,此字典的实例用于 ChatMessage 中的 metadata 字段。

🔗
title: str

“思考”消息的标题。唯一必需的字段。

🔗
id: int | str

消息的 ID。仅用于嵌套思考。可以通过将 parent_id 设置为父思考的 id 来嵌套嵌套思考。

🔗
parent_id: int | str

父消息的 ID。仅用于嵌套思考。

🔗
log: str

在思考标题旁边以柔和字体显示的字符串消息。

🔗
duration: float

消息的持续时间(秒)。以柔和字体显示在思考标题旁边的括号内。

🔗
status: Literal['pending', 'done']

如果设置为 `'pending'`,则思考标题旁边会出现一个微调器,并且手风琴初始化为打开状态。如果 `status` 为 `'done'`,则思考手风琴初始化为关闭状态。如果未提供 `status`,则思考手风琴初始化为打开状态,并且不显示微调器。

OptionDict

一个类型化的字典,用于表示 ChatMessage 中的选项。这些字典的列表用于 ChatMessage 中的 options 字段。

🔗
value: str

选择选项时要返回的值。

🔗
label: str

选项中显示的文本,如果与值不同。

指南