组件
HighlightedText

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

Gallery

HTML

HighlightedText

gradio.HighlightedText(···)

import gradio as gr with gr.Blocks() as demo: gr.HighlightedText( value=[ ("The ", "article"), ("quick ", "adjective"), ("brown ", "adjective"), ("fox ", "noun"), ("jumps ", "verb"), ("over ", "preposition"), ("the ", "article"), ("lazy ", "adjective"), ("dog", "noun"), ], combine_adjacent=True, ) demo.launch()

描述

显示包含按类别或数值高亮显示的文本片段。

行为

作为输入组件: 将值作为元组列表，以 `list[tuple]` 的形式传递给函数。每个 `tuple` 包含文本的 `str` 子字符串（因此包含整个文本）和一个 `str | float | None` 标签，该标签是该子字符串的类别或置信度。

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

def predict(
	value: list[tuple[str, str | float | None]] | None
)
	...

作为输出组件: 接受一个由 (单词, 类别) 元组构成的列表，或者一个包含两个键的字典：“text”和“entities”；其中“entities”键对应的值本身是一个字典列表，每个字典都包含以下键：“entity”（或“entity_group”）、“start”和“end”。

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

def predict(···) -> list[tuple[str, str | float | None]] | dict | None
	...	
	return value

初始化

🔗

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

默认 = None

要显示的默认值。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

color_map: dict[str, str] | None

默认 = None

一个将标签映射到颜色的字典。颜色可以指定为十六进制代码或其名称。例如：{"person": "red", "location": "#FFEE22"}

🔗

show_legend: bool

默认 = False

是否在单独的图例中或行内显示文本片段类别。

🔗

show_inline_category: bool

默认 = True

如果为 False，则不显示文本片段类别标签。仅当 show_legend=False 且 interactive=False 时适用。

🔗

combine_adjacent: bool

默认 = False

如果为 True，则会合并属于同一类别的相邻标记的标签。

🔗

adjacent_separator: str

默认 = ""

如果 combine_adjacent 为 True，则指定标记之间使用的分隔符。

🔗

label: str | I18nData | None

默认 = None

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

🔗

every: Timer | float | None

默认 = None

如果 `value` 是一个函数（否则无效果），则持续调用 `value` 以重新计算它。可以提供一个计时器，其计时重置 `value`，或者一个浮点数，提供重置计时器的常规间隔。

🔗

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 中 top-level 组件（当 fill_height=True 时）。

🔗

min_width: int

默认 = 160

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

🔗

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

在 gr.render 中，在重新渲染时具有相同 key 的组件被视为同一组件，而不是新组件。在 'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗

preserved_by_key: list[str] | str | None

默认 = "value"

此组件构造函数中的参数列表。在 gr.render() 函数内部，如果组件以相同的 key 重新渲染，这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

🔗

interactive: bool | None

默认 = None

如果为 True，该组件将可编辑，并允许用户选择文本片段并为其添加标签。

🔗

rtl: bool

默认 = False

如果为 True，将以从右到左的方向显示文本，图例中的标签也将右对齐。

快捷方式

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

演示

from difflib import Differ import gradio as gr def diff_texts(text1, text2): d = Differ() return [ (token[2:], token[0] if token[0] != " " else None) for token in d.compare(text1, text2) ] demo = gr.Interface( diff_texts, [ gr.Textbox( label="Text 1", info="Initial text", lines=3, value="The quick brown fox jumped over the lazy dogs.", ), gr.Textbox( label="Text 2", info="Text to compare", lines=3, value="The fast brown fox jumps over lazy dogs.", ), ], gr.HighlightedText( label="Diff", combine_adjacent=True, show_legend=True, color_map={"+": "red", "-": "green"}), theme=gr.themes.Base() ) if __name__ == "__main__": demo.launch()

from difflib import Differ

import gradio as gr

def diff_texts(text1, text2):
    d = Differ()
    return [
        (token[2:], token[0] if token[0] != " " else None)
        for token in d.compare(text1, text2)
    ]

demo = gr.Interface(
    diff_texts,
    [
        gr.Textbox(
            label="Text 1",
            info="Initial text",
            lines=3,
            value="The quick brown fox jumped over the lazy dogs.",
        ),
        gr.Textbox(
            label="Text 2",
            info="Text to compare",
            lines=3,
            value="The fast brown fox jumps over lazy dogs.",
        ),
    ],
    gr.HighlightedText(
        label="Diff",
        combine_adjacent=True,
        show_legend=True,
        color_map={"+": "red", "-": "green"}),
    theme=gr.themes.Base()
)
if __name__ == "__main__":
    demo.launch()

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`HighlightedText.change(fn, ···)`	当 HighlightedText 的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`HighlightedText.select(fn, ···)`	当用户选择或取消选择 HighlightedText 时触发的事件监听器。使用事件数据 gradio.SelectData 来携带指代 HighlightedText 标签的 `value`，以及指代 HighlightedText 状态的 `selected`。请参阅 EventData 文档了解如何使用此事件数据。

事件参数

🔗

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

可选的前端 js 方法，在运行 'fn' 之前运行。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()。如果设置，当键相同时，此值将标识重新渲染时相同的事件。

指南

命名实体识别

←

Gallery

HTML

→

HighlightedText

描述

显示包含按类别或数值高亮显示的文本片段。

行为

作为输入组件: 将值作为元组列表，以 list[tuple] 的形式传递给函数。每个 tuple 包含文本的 str 子字符串（因此包含整个文本）和一个 str | float | None 标签，该标签是该子字符串的类别或置信度。

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

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

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

指南

作为输入组件: 将值作为元组列表，以 `list[tuple]` 的形式传递给函数。每个 `tuple` 包含文本的 `str` 子字符串（因此包含整个文本）和一个 `str | float | None` 标签，该标签是该子字符串的类别或置信度。