Skip to content

Add label and interactive fields to EntitySource #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jiwon-oai merged 2 commits into from
Dec 15, 2025
Merged

Add label and interactive fields to EntitySource #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
002dd9f
Add EntitySource.label
jiwon-oai Dec 12, 2025
67064fb
Add interactive attr as well
jiwon-oai Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions chatkit/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,14 @@ class EntitySource(SourceBase):
type: Literal["entity"] = "entity"
id: str
icon: IconName | None = None
label: str | None = None
"""Optional label shown with the icon in the default entity hover header
when no preview callback is provided.
"""
interactive: bool = False
"""Per-entity toggle to wire client callbacks and render this entity as interactive."""
data: dict[str, Any] = Field(default_factory=dict)
"""Additional data for the entity source that is passed to client entity callbacks."""

preview: Literal["lazy"] | None = Field(
default=None,
Expand Down