Gradio 智能体与 MCP 黑客马拉松

优胜者
Gradio logo
  1. 组件
  2. 下拉菜单

Gradio 新手？从这里开始： 入门

查看 发布历史

←

DownloadButton

DuplicateButton

→

下拉菜单

gradio.Dropdown(···)
import gradio as gr with gr.Blocks() as demo: gr.Dropdown(choices=["First Choice", "Second Choice", "Third Choice"]) demo.launch()

描述

创建一个下拉菜单，可以从中选择单个或多个条目（作为输入组件），或显示（作为输出组件）。

行为

作为输入组件: 根据 type，将所选下拉菜单选项的值作为 str | int | float 传递给函数，或将其索引作为 int 传递给函数。或者，如果 multiselect 为 True，则将所选下拉菜单选项的值作为相应值/索引的列表传递。

您的函数应接受以下类型之一
def predict(
	value: str | int | float | list[str | int | float] | list[int | None] | None
)
	...

作为输出组件: 期望一个 str | int | float，对应于要选择的下拉菜单条目的值。或者，如果 multiselect 为 True，则期望一个 list 值，对应于所选的下拉菜单条目。

您的函数应返回以下类型之一
def predict(···) -> str | int | float | list[str | int | float] | None
	...	
	return value

初始化

参数
🔗 
choices: list[str | int | float | tuple[str, str | int | float]] | None
默认 = None

字符串或数字选项列表，供选择。选项也可以是 (name, value) 形式的元组，其中 name 是下拉菜单选项的显示名称，value 是要传递给函数或由函数返回的值。

🔗 
value: str | int | float | list[str | int | float] | Callable | DefaultValue | None
默认 = DefaultValue()

下拉菜单中选定的值。如果 `multiselect` 为 True，则应为列表，否则为 `choices` 中的单个字符串或数字。默认情况下，`choices` 中的第一个选项会被初步选择。如果明确设置为 None，则没有值被初步选择。如果提供了函数，每次应用加载时都会调用该函数以设置此组件的初始值。

🔗 
type: Literal['value', 'index']
默认 = "value"

组件返回的值类型。"value" 返回所选选项的字符串，"index" 返回所选选项的索引。

🔗 
multiselect: bool | None
默认 = None

如果为 True，可以选择多个选项。

🔗 
allow_custom_value: bool
默认 = False

如果为 True，允许用户输入不在选项列表中的自定义值。

🔗 
max_choices: int | None
默认 = None

可选择的最大选项数。如果为 None，则不强制限制。

🔗 
filterable: bool
默认 = True

如果为 True，用户将能够在下拉菜单中输入并根据输入过滤选项。仅当 `allow_custom_value` 为 False 时才能设置为 False。

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

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

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

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

🔗 
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 在一行中，A 的 scale=2，B 的 scale=1，则 A 将是 B 的两倍宽。应为整数。scale 适用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
默认 = 160

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

🔗 
interactive: bool | None
默认 = None

如果为 True，此下拉菜单中的选项将可选择；如果为 False，则选择将被禁用。如果未提供，则根据组件是作为输入还是输出使用来推断。

🔗 
visible: bool
默认 = True

如果为 False，组件将隐藏。

🔗 
elem_id: str | None
默认 = None

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

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

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

🔗 
render: bool
默认 = True

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

🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None
🔗 
preserved_by_key: list[str] | str | None
默认 = "value"

快捷方式

类 接口字符串快捷方式 初始化

gradio.Dropdown

"dropdown"

 使用默认值

演示

import gradio as gr

def sentence_builder(quantity, animal, countries, place, activity_list, morning):
    return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}"""

demo = gr.Interface(
    sentence_builder,
    [
        gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"),
        gr.Dropdown(
            ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!"
        ),
        gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"),
        gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"),
        gr.Dropdown(
            ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl."
        ),
        gr.Checkbox(label="Morning", info="Did they do it in the morning?"),
    ],
    "text",
    examples=[
        [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True],
        [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False],
        [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False],
        [8, "cat", ["Pakistan"], "zoo", ["ate"], True],
    ]
)

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

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

Dropdown.change(fn, ···)

当 Dropdown 的值发生变化时触发，原因可以是用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出中接收值）。有关仅由用户输入触发的监听器，请参阅 .input()。

Dropdown.input(fn, ···)

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

Dropdown.select(fn, ···)

当用户选择或取消选择 Dropdown 时触发的事件监听器。使用事件数据 gradio.SelectData 携带引用 Dropdown 标签的 value，以及引用 Dropdown 状态的 selected。有关如何使用此事件数据，请参阅 EventData 文档。

Dropdown.focus(fn, ···)

当 Dropdown 获得焦点时触发此监听器。

Dropdown.blur(fn, ···)

当 Dropdown 失去焦点/模糊时触发此监听器。

Dropdown.key_up(fn, ···)

当用户在 Dropdown 获得焦点时按下键盘按键时触发此监听器。

事件参数

参数
🔗 
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 | Literal[False]
默认 = None

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

🔗 
scroll_to_output: bool
默认 = False

如果为 True，完成后将滚动到输出组件。

🔗 
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 表示没有 concurrency_limit（此事件可以同时运行任意数量）。设置为 "default" 以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗 
concurrency_id: str | None
默认 = None

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

🔗 
show_api: bool
默认 = True

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

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

此事件监听器在 @gr.render() 中使用的唯一键。如果设置，此值在键相同时，会将事件标识为跨重新渲染是相同的。

←

DownloadButton

DuplicateButton

→