ui_job_context

User-facing job group context (compatibility shim).

A group dispatched by a UIWorker is client-visible, so a plain JobGroupContext covers what this subclass used to. It keeps the historical constructor signature for code that imported it directly.

class pipecat.workers.ui.ui_job_context.UIJobGroupContext(**kwargs)[source]

Bases: JobGroupContext

Deprecated alias for a JobGroupContext on a UIWorker.

Deprecated since version 1.8.0: Use JobGroupContext instead; a group dispatched by a UIWorker is client-visible either way. Will be removed in 2.0.0.

__init__(worker: BaseWorker, worker_names: tuple[str, ...], *, name: str | None = None, payload: dict | None = None, timeout: float | None = None, cancel_on_error: bool = True, label: str | None = None, cancellable: bool = True)[source]

Initialize with the historical UIJobGroupContext signature.

property label: str | None

The group’s human-readable label.

property cancellable: bool

Whether the client may request cancellation.