1. 组件
  2. 聊天机器人

刚开始使用 Gradio? 从这里开始: 入门指南

查看 发布历史

聊天机器人

gradio.Chatbot(···)

描述

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

行为

Chatbot 组件接受消息列表,其中每条消息都是一个包含 rolecontent 键的字典。此格式与大多数 LLM API(OpenAI、Claude、HuggingChat 等)预期的消息格式兼容,可以轻松地将模型输出直接管道传输到该组件。

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)

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)

demo.launch()

初始化

参数
🔗
value: list[MessageDict | Message] | Callable | None
默认 = None

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

🔗
label: str | I18nData | None
默认 = None

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

🔗
every: Timer | float | None
默认 = None

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

🔗
inputs: Component | list[Component] | set[Component] | None
默认 = None

用作计算 `value` 的输入的组件(如果 `value` 是一个函数,否则无效)。`value` 在输入更改时会重新计算。

🔗
show_label: bool | None
默认 = None

如果为 True,将显示标签。

🔗
container: bool
默认 = True

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

🔗
scale: int | None
默认 = None

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

🔗
min_width: int
默认 = 160

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

🔗
visible: bool | Literal['hidden']
默认 = True

如果为 False,则组件将隐藏。如果为“hidden”,则组件将视觉上隐藏并且不会在布局中占用空间,但仍存在于 DOM 中。

🔗
elem_id: str | None
默认 = None

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

🔗
elem_classes: list[str] | str | None
默认 = None

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

🔗
autoscroll: bool
默认 = True

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

🔗
render: bool
默认 = True

如果为 False,则组件不会在 Blocks 上下文中渲染。如果打算现在分配事件监听器,但稍后渲染组件,则应使用此选项。

🔗
key: int | str | tuple[int | str, ...] | None
默认 = None

在 `gr.render` 中,跨重渲染具有相同键的组件被视为同一个组件,而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。

🔗
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部,如果一个组件使用相同的键进行重渲染,则这些(也是唯一的)参数将在 UI 中被保留(如果它们已被用户或事件监听器更改),而不是根据构造函数中提供的值进行重渲染。

🔗
height: int | str | None
默认 = 400

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

🔗
resizable: bool
默认 = False

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

🔗
max_height: int | str | None
默认 = None

组件的最大高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。如果消息超过高度,组件将滚动。如果消息短于高度,组件将收缩以适应内容。如果设置了 height 且其值小于 max_height,则此参数将不起作用。

🔗
min_height: int | str | None
默认 = None

组件的最小高度,如果传递数字,则以像素为单位指定;如果传递字符串,则以 CSS 单位指定。如果消息超过高度,组件将扩展以适应内容。如果设置了 height 且其值大于 min_height,则此参数将不起作用。

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

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

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

一个字典列表,形式为 {"left": 开头定界符 (str), "right": 结尾定界符 (str), "display": 是否在新行中显示 (bool)},用于渲染 LaTeX 表达式。如果未提供,则 `latex_delimiters` 设置为 `[{ "left": "$$", "right": "$$", "display": True }]`,因此只有用 $$ 定界符括起来的表达式将在新行中渲染为 LaTeX。传递空列表可禁用 LaTeX 渲染。有关更多信息,请参阅 KaTeX 文档

🔗
rtl: bool
默认 = False

如果为 True,则将渲染文本的方向设置为从右到左。默认为 False,表示从左到右渲染文本。

🔗
buttons: list[Literal['share', 'copy', 'copy_all'] | Button] | None
默认 = None

显示在组件右上角的按钮列表。有效选项是 "share"、"copy"、"copy_all" 或 gr.Button() 实例。"share" 按钮允许用户将输出共享到 Hugging Face Spaces 讨论。"copy" 按钮将在每个单独的聊天机器人消息旁边显示一个复制按钮。"copy_all" 按钮显示在组件级别,允许用户复制所有聊天机器人消息。自定义 gr.Button() 实例将以其配置的图标和/或标签显示在工具栏中,单击它们将触发在按钮上注册的任何 .click() 事件。默认情况下,显示 "share" 和 "copy_all" 按钮。

🔗
watermark: str | None
默认 = None

如果提供,此文本将在聊天机器人中复制的消息末尾追加,后跟一个空行。有助于表明消息是由 AI 模型生成的。

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

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

🔗
sanitize_html: bool
默认 = True

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

🔗
render_markdown: bool
默认 = True

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

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

用户将看到的反馈选项字符串列表。精确的大小写敏感字符串 "Like" 和 "Dislike" 将渲染为拇指图标,但任何其他选择将出现在单独的旗帜图标下。

🔗
feedback_value: list[str | None] | None
默认 = None

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

🔗
line_breaks: bool
默认 = True

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

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

如果为 "panel",则将以 LLM 风格的布局显示聊天机器人。如果为 "bubble",则将以消息气泡的形式显示聊天机器人,用户和机器人消息将交替显示。将默认为 "bubble"。

🔗
placeholder: str | None
默认 = None

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

🔗
examples: list[ExampleMessage] | None
默认 = None

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

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

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

🔗
group_consecutive_messages: bool
默认 = True

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

🔗
allow_tags: list[str] | bool
默认 = True

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

🔗
reasoning_tags: list[tuple[str, str]] | None
默认 = None

如果提供,则是一个元组列表,包含 (open_tag, close_tag) 字符串。这些标签之间的任何文本都将被提取并显示在一个单独的可折叠消息中,元数据为 {"title": "Reasoning"}。例如,[("<thinking>", "</thinking>")] 将提取 <thinking> 和 </thinking> 标签之间的内容。每个思考块将显示为一个单独的可折叠消息,位于主响应之前。如果为 None(默认),则不执行自动提取。

🔗
like_user_message: bool
默认 = False

如果为 True,还将为用户消息显示喜欢/不喜欢按钮。默认为 False。

快捷方式

快捷方式
gradio.Chatbot
界面字符串快捷方式 "chatbot"
初始化 使用默认值

示例

显示思想/工具使用情况

您可以提供有关用于生成响应的任何工具的附加元数据。这对于显示 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)。只需将这些组件之一包含在消息的 content 中即可。这是一个示例:

import gradio as gr

def load():
    return [
        {"role": "user", "content": "Can you show me some media?"},
        {"role": "assistant", "content": "Here's an audio clip:"},
        {"role": "assistant", "content": gr.Audio("https://github.com/gradio-app/gradio/raw/gradio/media_assets/audio/audio_sample.wav")},
        {"role": "assistant", "content": "And here's a video:"},
        {"role": "assistant", "content": gr.Video("https://github.com/gradio-app/gradio/raw/gradio/media_assets/videos/world.mp4")}
    ]

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

demo.launch()

演示

事件监听器

描述

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

支持的事件监听器

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

监听器
Chatbot.change(fn, ···)

当聊天机器人值更改时触发,这可能是由于用户输入(例如,用户在文本框中输入)或函数更新(例如,图像接收来自事件触发器输出的值)。请参阅 .input(),它仅由用户输入触发。

Chatbot.select(fn, ···)

当用户选择或取消选择聊天机器人时触发的事件监听器。使用事件数据 gradio.SelectData 来传递 value(指聊天机器人的标签)和 selected(指聊天机器人的状态)。有关更多详细信息,请参阅 https://gradio.org.cn/docs/gradio/eventdata

Chatbot.like(fn, ···)

当用户在聊天机器人中喜欢/不喜欢时触发此监听器。此事件具有类型为 gradio.LikeData 的 EventData,其中包含通过 LikeData.index 和 LikeData.value 可访问的信息。请参阅 EventData 文档了解如何使用此事件数据。

Chatbot.retry(fn, ···)

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

Chatbot.undo(fn, ···)

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

Chatbot.example_select(fn, ···)

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

Chatbot.option_select(fn, ···)

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

Chatbot.clear(fn, ···)

当用户使用组件的清除按钮清除聊天机器人时触发此监听器。

Chatbot.copy(fn, ···)

当用户从聊天机器人复制内容时触发此监听器。使用事件数据 gradio.CopyData 来传递有关复制内容的信息。请参阅 EventData 文档了解如何使用此事件数据。

Chatbot.edit(fn, ···)

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

事件参数

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

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

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

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

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

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

🔗
api_name: str | None
默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串,则该端点将在 API 文档中以给定名称显示。如果为 None(默认),则使用函数的名称作为 API 端点。

🔗
api_description: str | None | Literal[False]
默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串,则该端点将在 API 文档中以给定描述显示。如果为 None,则使用函数的 docstring 作为 API 端点描述。如果为 False,则 API 文档中不会显示任何描述。

🔗
scroll_to_output: bool
默认 = False

完成后是否滚动到输出组件

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

事件运行时如何显示进度动画:“full”显示一个覆盖输出组件区域的加载指示器,并在右上角显示运行时信息,“minimal”仅显示运行时信息,“hidden”不显示任何进度动画。

🔗
show_progress_on: Component | list[Component] | None
默认 = None

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

🔗
queue: bool
默认 = True

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

🔗
batch: bool
默认 = False

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

🔗
max_batch_size: int
默认 = 4

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

🔗
preprocess: bool
默认 = True

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

🔗
postprocess: bool
默认 = True

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

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

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

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

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

🔗
js: str | Literal[True] | None
默认 = None

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

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

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

🔗
concurrency_id: str | None
默认 = None

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

🔗
api_visibility: Literal['public', 'private', 'undocumented']
默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"(在 API 文档中显示并可由客户端调用)、"private"(在 API 文档中隐藏,不可由客户端调用)或 "undocumented"(在 API 文档中隐藏,但可由客户端通过 gr.load 调用)。如果 fn 为 None,则 api_visibility 将自动设置为 "private"。

🔗
time_limit: int | None
默认 = None
🔗
stream_every: float
默认 = 0.5
🔗
key: int | str | tuple[int | str, ...] | None
默认 = None

此事件监听器的唯一键,用于 @gr.render()。如果设置,此值标识在重渲染时具有相同键的事件为相同的事件。

🔗
validator: Callable | None
默认 = None

可选的验证函数,在主函数运行之前执行。如果提供,此函数将首先使用 queue=False 执行,只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入,并应为每个输入值返回一个 `gr.validate()`。

辅助类

ChatMessage

gradio.ChatMessage(···)

描述

代表 Chatbot 组件中消息的数据类(type="messages")。唯一必需的字段是 contentgr.Chatbot 的值是这些数据类的列表。

参数
🔗
content: MessageContent | list[MessageContent]

消息的内容。可以是字符串、文件字典、gradio 组件,或这些类型的列表,用于将这些消息分组在一起。

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

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

🔗
metadata: MetadataDict
默认 = _HAS_DEFAULT_FACTORY_CLASS()

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

🔗
options: list[OptionDict]
默认 = _HAS_DEFAULT_FACTORY_CLASS()

消息的选项。一个选项对象列表,这些对象是包含以下键的字典:“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

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

gradio