Gradio Agents & MCP 黑客松
获奖者Gradio Agents & MCP 黑客松
获奖者gradio.State(···)
def predict(
value: Any
)
...
def predict(···) -> Any
...
return value
事件监听器允许您响应用户与 Gradio Blocks 应用中定义的 UI 组件的交互。当用户与某个元素交互时,例如更改滑块值或上传图像,会调用一个函数。
状态 组件支持以下事件监听器。每个事件监听器都接受相同的参数,这些参数列在下面的 事件参数 表中。
监听器 | 描述 |
---|---|
| 当状态值因用户输入(例如用户在文本框中输入)或函数更新(例如图像从事件触发器的输出接收值)而改变时触发。有关仅由用户输入触发的监听器,请参阅 |
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` 此应用的应用)将无法使用此事件。
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`)。然后,函数 *必须* 返回一个列表元组(即使只有一个输出组件),其中元组中的每个列表对应一个输出组件。
preprocess: bool
= True
如果为 False,则在运行 'fn' 之前不会对组件数据进行预处理(例如,如果使用 `Image` 组件调用此方法,则将其保留为 base64 字符串)。
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 的限制。