Skip to content

widget models

Canonical widget trees for JSON, streaming, and storage.

WidgetComponent

Bases: BaseModel

A widget node whose JSON properties survive streaming and storage.

Source code in chatkit/widget_models.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class WidgetComponent(BaseModel):
    """A widget node whose JSON properties survive streaming and storage."""

    model_config = ConfigDict(extra="allow")
    __pydantic_extra__: dict[str, JsonValue] = Field(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]

    type: str
    id: str | None = None
    key: str | None = None
    children: WidgetComponent | list[WidgetComponent] | None = None

    @model_serializer
    def _serialize(self) -> dict[str, Any]:
        # Preserve explicit JSON nulls even when the enclosing event uses
        # exclude_none. Only unset optional node fields are absent on the wire.
        data = {"type": self.type, **(self.model_extra or {})}
        for field in ("id", "key", "children"):
            if field in self.model_fields_set:
                data[field] = getattr(self, field)
        return data

WidgetRoot

Bases: WidgetComponent

The canonical layout used by widget events and saved thread items.

Source code in chatkit/widget_models.py
30
31
32
33
class WidgetRoot(WidgetComponent):
    """The canonical layout used by widget events and saved thread items."""

    type: Literal["Card", "ListView", "Basic"]  # pyright: ignore[reportIncompatibleVariableOverride]