Merge pull request #64 from openai/client-side-effect

ClientEffectEvent

Author: jiwon-oai

chatkit/types.py

@@ -339,6 +339,14 @@ class ProgressUpdateEvent(BaseModel):
     text: str
 
 
+class ClientEffectEvent(BaseModel):
+    """Event emitted to trigger a client side-effect."""
+
+    type: Literal["client_effect"] = "client_effect"
+    name: str
+    data: dict[str, Any] = Field(default_factory=dict)
+
+
 class ErrorEvent(BaseModel):
     """Event indicating an error occurred while processing a thread."""
 
@@ -370,6 +378,7 @@ class NoticeEvent(BaseModel):
     | ThreadItemReplacedEvent
     | StreamOptionsEvent
     | ProgressUpdateEvent
+    | ClientEffectEvent
     | ErrorEvent
     | NoticeEvent,
     Field(discriminator="type"),