events
Stream events and updates delivered to ChatKit clients.
ThreadStreamEvent
module-attribute
ThreadStreamEvent = Annotated[ThreadCreatedEvent | ThreadUpdatedEvent | ThreadItemDoneEvent | ThreadItemAddedEvent | ThreadItemUpdatedEvent | ThreadItemRemovedEvent | ThreadItemReplacedEvent | StreamOptionsEvent | ProgressUpdateEvent | ClientEffectEvent | ErrorEvent | NoticeEvent, Field(discriminator='type')]
Union of all streaming events emitted to clients.
ThreadItemUpdate
module-attribute
ThreadItemUpdate = AssistantMessageContentPartAdded | AssistantMessageContentPartTextDelta | AssistantMessageContentPartAnnotationAdded | AssistantMessageContentPartDone | WidgetStreamingTextValueDelta | WidgetComponentUpdated | WidgetRootUpdated | WorkflowTaskAdded | WorkflowTaskUpdated | GeneratedImageUpdated
Union of possible updates applied to thread items.
ThreadCreatedEvent
Bases: BaseModel
Event emitted when a thread is created.
Source code in chatkit/events.py
10 11 12 13 14 | |
ThreadUpdatedEvent
Bases: BaseModel
Event emitted when a thread is updated.
Source code in chatkit/events.py
17 18 19 20 21 | |
ThreadItemAddedEvent
Bases: BaseModel
Event emitted when a new item is added to a thread.
Source code in chatkit/events.py
24 25 26 27 28 | |
ThreadItemUpdatedEvent
Bases: BaseModel
Event describing an update to an existing thread item.
Source code in chatkit/events.py
31 32 33 34 35 36 | |
ThreadItemDoneEvent
Bases: BaseModel
Event emitted when a thread item is marked complete.
Source code in chatkit/events.py
39 40 41 42 43 | |
ThreadItemRemovedEvent
Bases: BaseModel
Event emitted when a thread item is removed.
Source code in chatkit/events.py
46 47 48 49 50 | |
ThreadItemReplacedEvent
Bases: BaseModel
Event emitted when a thread item is replaced.
Source code in chatkit/events.py
53 54 55 56 57 | |
StreamOptions
Bases: BaseModel
Settings that control runtime stream behavior.
Source code in chatkit/events.py
60 61 62 63 64 | |
allow_cancel
instance-attribute
allow_cancel: bool
Allow the client to request cancellation mid-stream.
StreamOptionsEvent
Bases: BaseModel
Event emitted to set stream options at runtime.
Source code in chatkit/events.py
67 68 69 70 71 | |
ProgressUpdateEvent
Bases: BaseModel
Event providing incremental progress from the assistant.
Source code in chatkit/events.py
74 75 76 77 78 79 | |
ClientEffectEvent
Bases: BaseModel
Event emitted to trigger a client side-effect.
Source code in chatkit/events.py
82 83 84 85 86 87 | |
ErrorEvent
Bases: BaseModel
Event indicating an error occurred while processing a thread.
Source code in chatkit/events.py
90 91 92 93 94 95 96 | |
NoticeEvent
Bases: BaseModel
Event conveying a user-facing notice.
Source code in chatkit/events.py
99 100 101 102 103 104 105 106 107 108 | |
message
instance-attribute
message: str
Supports markdown e.g. "You've reached your limit of 100 messages. Upgrade to a paid plan."
AssistantMessageContentPartAdded
Bases: BaseModel
Event emitted when new assistant content is appended.
Source code in chatkit/events.py
131 132 133 134 135 136 137 138 | |
AssistantMessageContentPartTextDelta
Bases: BaseModel
Event carrying incremental assistant text output.
Source code in chatkit/events.py
141 142 143 144 145 146 147 148 | |
AssistantMessageContentPartAnnotationAdded
Bases: BaseModel
Event announcing a new annotation on assistant content.
Source code in chatkit/events.py
151 152 153 154 155 156 157 158 159 | |
AssistantMessageContentPartDone
Bases: BaseModel
Event indicating an assistant content part is finalized.
Source code in chatkit/events.py
162 163 164 165 166 167 168 169 | |
WidgetStreamingTextValueDelta
Bases: BaseModel
Event streaming widget text deltas.
Source code in chatkit/events.py
172 173 174 175 176 177 178 179 180 | |
WidgetRootUpdated
Bases: BaseModel
Event published when the widget root changes.
Source code in chatkit/events.py
183 184 185 186 187 | |
WidgetComponentUpdated
Bases: BaseModel
Event emitted when a widget component updates.
Source code in chatkit/events.py
190 191 192 193 194 195 | |
WorkflowTaskAdded
Bases: BaseModel
Event emitted when a workflow task is added.
Source code in chatkit/events.py
198 199 200 201 202 203 | |
WorkflowTaskUpdated
Bases: BaseModel
Event emitted when a workflow task is updated.
Source code in chatkit/events.py
206 207 208 209 210 211 | |
GeneratedImageUpdated
Bases: BaseModel
Event emitted when a generated image is updated.
Source code in chatkit/events.py
214 215 216 217 218 219 | |
SyncCustomActionResponse
Bases: BaseModel
Single thread item update returned by a sync custom action.
Source code in chatkit/events.py
237 238 239 240 | |