组件
MultimodalTextbox

Gradio 新手？从这里开始：快速开始

Model3D

Number

MultimodalTextbox

gradio.MultimodalTextbox(···)

import gradio as gr with gr.Blocks() as demo: gr.MultimodalTextbox(interactive=True) demo.launch()

描述

创建一个文本输入框，用户可以在其中输入字符串或显示字符串输出，并允许上传多媒体文件。

行为

作为输入组件: 将文本值和文件列表作为 `dict` 传递给函数。

你的函数应该接受以下类型之一

def predict(
	value: MultimodalValue | None
)
	...

作为输出组件: 期望一个 `dict`，包含 "text" 和 "files"，两者都是可选的。"files" 数组是文件路径或 URL 的列表。

你的函数应该返回以下类型之一

def predict(···) -> MultimodalValue | None
	...	
	return value

初始化

🔗

value: str | dict[str, str | list] | Callable | None

default = None

MultimodalTextbox 中显示的默认值。字符串值，或 {"text": "示例文本", "files": [{path: "files/file.jpg", orig_name: "file.jpg", url: "http://image_url.jpg", size: 100}]} 形式的字典。如果提供函数，则每次应用加载时都会调用该函数以设置此组件的初始值。

🔗

sources: list[Literal['upload', 'microphone']] | Literal['upload', 'microphone'] | None

default = None

允许的来源列表。"upload" 创建一个按钮，用户可以点击上传或拖放文件，"microphone" 创建麦克风输入。如果为 None，则默认为 ["upload"]。

🔗

file_types: list[str] | None

default = None

要上传的文件扩展名或文件类型列表（例如，['image', '.json', '.mp4']）。"file" 允许上传任何文件，"image" 仅允许上传图像文件，"audio" 仅允许上传音频文件，"video" 仅允许上传视频文件，"text" 仅允许上传文本文件。

🔗

file_count: Literal['single', 'multiple', 'directory']

default = "single"

如果为 "single"，允许用户上传一个文件。如果为 "multiple"，用户上传多个文件。如果为 "directory"，用户上传所选目录中的所有文件。对于 "multiple" 或 "directory" 的情况，返回类型将是列表。

🔗

lines: int

default = 1

文本框中提供的最小行数。

🔗

max_lines: int

default = 20

文本框中提供的最大行数。

🔗

placeholder: str | None

default = None

在文本框后提供的占位符提示。

🔗

label: str | None

default = None

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

🔗

info: str | None

default = None

附加组件描述，以较小字体显示在标签下方。支持 markdown / HTML 语法。

🔗

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 在同一 Row 中，并且 A 的 scale=2，B 的 scale=1，则 A 的宽度将是 B 的两倍。应该是一个整数。scale 应用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

min_width: int

default = 160

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

🔗

interactive: bool | None

default = None

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

🔗

visible: bool

default = True

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

🔗

elem_id: str | None

default = None

一个可选字符串，被分配为此组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗

autofocus: bool

default = False

如果为 True，则在页面加载时聚焦文本框。谨慎使用，因为它可能会给有视觉障碍和非视觉障碍的用户带来可用性问题。

🔗

autoscroll: bool

default = True

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

🔗

elem_classes: list[str] | str | None

default = None

一个可选的字符串列表，被分配为此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗

render: bool

default = True

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

🔗

key: int | str | None

default = None

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

🔗

text_align: Literal['left', 'right'] | None

default = None

如何对齐文本框中的文本，可以是："left"、"right" 或 None（默认值）。如果为 None，则如果 `rtl` 为 False，则对齐方式为左对齐，如果 `rtl` 为 True，则对齐方式为右对齐。只有当 `type` 为 "text" 时才能更改。

🔗

rtl: bool

default = False

如果为 True 且 `type` 为 "text"，则将文本方向设置为从右到左（光标出现在文本的左侧）。默认值为 False，光标渲染在右侧。

🔗

submit_btn: str | bool | None

default = True

如果为 False，则不显示提交按钮。如果为字符串，则将该字符串用作提交按钮文本。

🔗

stop_btn: str | bool | None

default = False

如果为 True，将显示停止按钮（对于流式演示很有用）。如果为字符串，则将该字符串用作停止按钮文本。

🔗

max_plain_text_length: int

default = 1000

文本框中纯文本的最大长度。如果文本超过此长度，文本将作为文件粘贴。默认值为 1000。

快捷方式

类	界面字符串快捷方式	初始化
`gradio.MultimodalTextbox`	"multimodaltextbox"	使用默认值

演示

import gradio as gr import time # Chatbot demo with multimodal input (text, markdown, LaTeX, code blocks, image, audio, & video). Plus shows support for streaming text. def print_like_dislike(x: gr.LikeData): print(x.index, x.value, x.liked) def add_message(history, message): for x in message["files"]: history.append({"role": "user", "content": {"path": x}}) if message["text"] is not None: history.append({"role": "user", "content": message["text"]}) return history, gr.MultimodalTextbox(value=None, interactive=False) def bot(history: list): response = "**That's cool!**" history.append({"role": "assistant", "content": ""}) for character in response: history[-1]["content"] += character time.sleep(0.05) yield history with gr.Blocks() as demo: chatbot = gr.Chatbot(elem_id="chatbot", bubble_full_width=False, type="messages") chat_input = gr.MultimodalTextbox( interactive=True, file_count="multiple", placeholder="输入消息或上传文件...", show_label=False, sources=["microphone", "upload"], ) chat_msg = chat_input.submit( add_message, [chatbot, chat_input], [chatbot, chat_input] ) bot_msg = chat_msg.then(bot, chatbot, chatbot, api_name="bot_response") bot_msg.then(lambda: gr.MultimodalTextbox(interactive=True), None, [chat_input]) chatbot.like(print_like_dislike, None, None, like_user_message=True) if __name__ == "__main__": demo.launch()

import gradio as gr
import time

# Chatbot demo with multimodal input (text, markdown, LaTeX, code blocks, image, audio, & video). Plus shows support for streaming text.


def print_like_dislike(x: gr.LikeData):
    print(x.index, x.value, x.liked)


def add_message(history, message):
    for x in message["files"]:
        history.append({"role": "user", "content": {"path": x}})
    if message["text"] is not None:
        history.append({"role": "user", "content": message["text"]})
    return history, gr.MultimodalTextbox(value=None, interactive=False)


def bot(history: list):
    response = "**That's cool!**"
    history.append({"role": "assistant", "content": ""})
    for character in response:
        history[-1]["content"] += character
        time.sleep(0.05)
        yield history


with gr.Blocks() as demo:
    chatbot = gr.Chatbot(elem_id="chatbot", bubble_full_width=False, type="messages")

    chat_input = gr.MultimodalTextbox(
        interactive=True,
        file_count="multiple",
        placeholder="Enter message or upload file...",
        show_label=False,
        sources=["microphone", "upload"],
    )

    chat_msg = chat_input.submit(
        add_message, [chatbot, chat_input], [chatbot, chat_input]
    )
    bot_msg = chat_msg.then(bot, chatbot, chatbot, api_name="bot_response")
    bot_msg.then(lambda: gr.MultimodalTextbox(interactive=True), None, [chat_input])

    chatbot.like(print_like_dislike, None, None, like_user_message=True)

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

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`MultimodalTextbox.change(fn, ···)`	当 MultimodalTextbox 的值因用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`MultimodalTextbox.input(fn, ···)`	当用户更改 MultimodalTextbox 的值时，将触发此监听器。
`MultimodalTextbox.select(fn, ···)`	用户选择或取消选择 MultimodalTextbox 时的事件监听器。使用事件数据 gradio.SelectData 来携带 `value`（指 MultimodalTextbox 的标签）和 `selected`（指 MultimodalTextbox 的状态）。有关如何使用此事件数据的详细信息，请参阅 EventData 文档。
`MultimodalTextbox.submit(fn, ···)`	当用户在 MultimodalTextbox 获得焦点时按下 Enter 键时，将触发此监听器。
`MultimodalTextbox.focus(fn, ···)`	当 MultimodalTextbox 获得焦点时，将触发此监听器。
`MultimodalTextbox.blur(fn, ···)`	当 MultimodalTextbox 失去焦点/模糊时，将触发此监听器。
`MultimodalTextbox.stop(fn, ···)`	当用户到达 MultimodalTextbox 中播放的媒体末尾时，将触发此监听器。

事件参数

🔗

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 应用程序的 "view API" 页面或 Gradio 客户端的 ".view_api()" 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍将允许下游应用程序以及 Clients 使用此事件。如果 fn 为 None，则 show_api 将自动设置为 False。

🔗