1. 组件
  2. 对话框

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

查看 发布历史

对话框

gradio.Dialogue(···)

描述

创建一个 Dialogue 组件,用于显示或收集多说话人的对话。此组件可用作输入,允许用户输入涉及多说话人的对话,或用作输出,显示说话人分离的语音,例如转录或说话人识别模型的结果。每条消息都可以与特定的说话人关联,使其适用于对话、访谈或会议等用例。

行为

作为输入组件: 将对话作为字符串或字典列表返回。

您的函数应接受其中一种类型
def predict(
	value: tuple[str, list[tuple[str, str]]] | None
)
	...

作为输出组件: 期望一个字符串或一个包含对话行的字典列表,其中每个字典包含“speaker”和“text”键,或者一个字符串。

您的函数应返回其中一种类型
def predict(···) -> tuple[np.ndarray | PIL.Image.Image | str, list[tuple[np.ndarray | tuple[int, int, int, int], str]]] | None
	...	
	return value

初始化

参数
🔗
value: list[dict[str, str]] | Callable | None
默认 = None

对话的值。它是一个字典列表,每个字典包含一个“speaker”键和一个“text”键。如果提供了函数,则每次应用程序加载时都会调用该函数来设置此组件的初始值。

🔗
type: Literal['list', 'text']
默认值 = "text"

组件的类型,"list"表示由包含'speaker'和'text'键的字典组成的多说话人对话,或"text"表示单个文本输入。默认为"text"。

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

对话中允许的不同说话人。如果为 `None` 或空列表,则不显示说话人。相反,组件将是一个标准文本区域,可以选择支持 `tags` 自动补全。

🔗
formatter: Callable | None
默认 = None

一个格式化对话行字典(例如:{"speaker": "Speaker 1", "text": "Hello, how are you?"})为字符串(例如:"Speaker 1: Hello, how are you?")的函数。此函数在用户输入时运行,生成的字符串将传递给预测函数。

🔗
unformatter: Callable | None
默认 = None

一个将格式化的对话字符串解析回对话行字典的函数。应接受一个字符串行并返回一个包含“speaker”和“text”键的字典。如果未提供,默认的 unformatter 将尝试解析默认的 formatter 模式。

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

对话中允许的不同标签。当用户开始键入“:”时,标签会显示在输入文本框下方的自动补全菜单中。使用 AI 模型或推理函数期望的确切标签名称。

🔗
separator: str
默认值 = " "

用于将格式化的对话行连接成单个字符串的不同对话行之间的分隔符。它应该是不含糊的。例如,换行符或制表符。

🔗
color_map: dict[str, str] | None
默认 = None

将说话人名称映射到颜色的字典。颜色可以指定为十六进制代码或名称。例如:{"Speaker 1": "red", "Speaker 2": "#FFEE22"}。如果未提供,则将为说话人分配默认颜色。仅在 `interactive` 为 False 时使用。

🔗
label: str | None
默认值 = "Dialogue"

此组件的标签,如果 `show_label` 为 `True`,则显示在该组件上方,如果存在此组件的示例表格,它也将用作标题。如果为 None 且在 `gr.Interface` 中使用,则标签将是此组件对应的参数的名称。

🔗
info: str | None
默认值 = "在对话行中键入冒号 (:) 以查看可用标签"
🔗
placeholder: str | None
默认 = None

文本区域后面的占位符提示。

🔗
show_label: bool | None
默认 = None

如果为 True,将显示标签。如果为 False,则复制按钮和标签都将隐藏。

🔗
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 参数。

🔗
interactive: bool | None
默认 = None

如果为 True,将渲染为可编辑文本框;如果为 False,将禁用编辑。如果未提供,则根据组件是用作输入还是输出进行推断。

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

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

🔗
elem_id: str | None
默认 = None

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

🔗
autofocus: bool
默认 = False

如果为 True,当页面加载时文本框将获得焦点。请谨慎使用此选项,因为它可能会导致有视力和无视力用户的可用性问题。

🔗
autoscroll: bool
默认 = True

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

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

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

🔗
render: bool
默认 = True

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

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

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

🔗
max_lines: int | None
默认 = None

对话中允许的最大行数。

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

要为组件显示的按钮列表。有效选项是 "copy" 或 gr.Button() 实例。 "copy" 按钮允许用户复制文本框中的文本。自定义 gr.Button() 实例将与其配置的图标和/或标签一起出现在工具栏中,单击它们将触发在按钮上注册的任何 .click() 事件。默认情况下,不显示任何按钮。

🔗
submit_btn: str | bool | None
默认 = False

如果为 False,则不显示提交按钮。如果为 True,则显示带有图标的提交按钮。如果是字符串,则将该字符串用作提交按钮文本。

🔗
ui_mode: Literal['dialogue', 'text', 'both']
默认值 = "both"

确定组件的用户界面模式。可以是 "dialogue"(显示对话行),"text"(显示单个文本输入),或 "both"(同时显示对话行和文本输入)。默认为 "both"。

快捷方式

快捷方式
gradio.Dialogue
Interface String Shortcut "dialogue"
初始化 使用默认值

演示

事件监听器

描述

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

支持的事件监听器

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

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

当 Dialogue 的值发生变化时触发,无论是由于用户输入(例如,用户在文本框中输入)还是由于函数更新(例如,图像从事件触发器的输出接收值)。有关仅由用户输入触发的监听器,请参阅 .input()

Dialogue.input(fn, ···)

当用户更改 Dialogue 的值时触发此监听器。

Dialogue.submit(fn, ···)

当用户在 Dialogue 聚焦时按 Enter 键时触发此监听器。

事件参数

参数
🔗
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()`。

gradio