1.6.2

• Adds handling for sync actions via ChatKitServer.sync_action

  Normally, widget actions are blocked while a thread is streaming a response. This prevents race conditions, but it can be limiting when a widget action is only going to update itself or trigger side effects outside the thread. To get around this limitation, we're adding ChatKitServer.sync_action where you can run any side effects and update the widget's UI as needed. To route an action to this handler, add streaming: false to the action. If a widget action includes streaming: false it won't be blocked during streaming.

v1.6.1

• WidgetItem expanded to allow BasicRoot widgets.
• WidgetTemplate.build expanded to allow BasicRoot widgets; deprecated WidgetTemplate.build_basic.

v1.6.0

• Support dictation with input.transcribe op and ChatKitServer.transcribe
• Save thread id as part of attachment when user message is written to store
• Breaking:
  • Store.save_attachment may now be called with updates to existing attachments (treated as an upsert), not only inserts.

v1.5.3

• Add a metadata field on AttachmentBase for integration-internal use cases

v1.5.2

• Add support for Lucide icons via icon names with the lucide: prefix

v1.5.1

• Prevent duplicate workflow item tasks when ThreadItemDone is emitted for an existing workflow item instance.

v1.5.0

• Streaming annotations: Support custom mapping for assistant message annotations in stream_agent_response via ResponseStreamConverter.

• Two-phase uploads: Add PUT support and request header forwarding via upload_descriptor for FileAttachment and ImageAttachment.

• Breaking:

  • The upload_url field on FileAttachment and ImageAttachment has been removed (use upload_descriptor).
  • ChatKitServer now writes created attachment metadata to the store when handling the attachments.create request (remove store-write from AttachmentStore.create_attachment).

v1.4.2

• Remove unnecessary client tool call item cleanup on every new message

v1.4.1

• Support streaming generated images using a new GeneratedImageItem

  • Emit partial image updates with GeneratedImageUpdated
  • Enable custom image output handling through ResponseStreamConverter passed to
    stream_agent_response

• Add customization options for how EntitySource is rendered in assistant messages

  • Control inline and hover annotation views with inline_label and label
  • Mark entity sources as interactive to enable client-side click handling and previews

• Add a clock icon for use in workflows and entity annotations

v1.4.0

• Introduce WidgetTemplate for building widgets from .widget files instead of hand-crafting widget models.
• Add ClientEffectEvent for triggering client-side behavior in ChatKit.js.
• Add overridable ChatKitServer.handle_stream_cancelled and get_stream_options methods to support configurable response cancellation behavior.
• Add SDKHiddenContextItem with default ThreadItemConverter handling to store ChatKit-added hidden context in threads.

Breaking:

• Widget and action classes remain usable but are marked deprecated in favor of using WidgetTemplate
• jinja2 is a required dependency for widget template rendering.
• A stop button shows by default during streaming so users can cancel mid-response; integrations can override ChatKitServer.get_stream_options to change this.