Gradio 的月活跃用户达到 100 万！

阅读更多
Gradio logo
  1. 组件
  2. 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
default = None

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

🔗 
color_map: dict[str, str] | None
default = None

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

🔗 
show_legend: bool
default = False

是否在单独的图例或内联中显示跨度类别。

🔗 
show_inline_category: bool
default = True

如果为 False，则不会显示跨度类别标签。仅当 show_legend=False 且 interactive=False 时适用。

🔗 
combine_adjacent: bool
default = False

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

🔗 
adjacent_separator: str
default = ""

指定当 combine_adjacent 为 True 时，在标记之间使用的分隔符。

🔗 
label: str | None
default = None

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

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

🔗 
visible: bool
default = True

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

🔗 
elem_id: str | None
default = None

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

🔗 
elem_classes: list[str] | str | None
default = None

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

🔗 
render: bool
default = True

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

🔗 
key: int | str | None
default = None

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

🔗 
interactive: bool | None
default = None

如果为 True，则组件将是可编辑的，并允许用户选择文本跨度并标记它们。

🔗 
rtl: bool
default = False

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

快捷方式

类 Interface 字符串快捷方式 初始化

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()

事件侦听器

描述

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

支持的事件侦听器

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

侦听器 描述

HighlightedText.change(fn, ···)

当 HighlightedText 的值因用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像接收来自事件触发器输出的值）而更改时触发。有关仅由用户输入触发的侦听器，请参阅 .input()。

HighlightedText.select(fn, ···)

当用户选择或取消选择 HighlightedText 时的事件侦听器。使用事件数据 gradio.SelectData 来携带 value，该值引用 HighlightedText 的标签，以及 selected，该值引用 HighlightedText 的状态。请参阅 EventData 文档，了解如何使用此事件数据

事件参数

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

🔗 
time_limit: int | None
default = None
🔗 
stream_every: float
default = 0.5
🔗 
like_user_message: bool
default = False

指南

命名实体识别

←

Gallery

HTML

→