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.

v1.3.1

• Add optional group field to UserMessageTagContent
• Update default ThreadItemConverter to handle simple HiddenContextItem conversions
• Add ThreadItemUpdatedEvent and update ThreadItemUpdated to be a type alias for the former for backwards compatibility
• Add BasicRoot widget type to allow server-side building of entity preview widgets

v1.3.0

• Fix type for Checkbox defaultChecked

v1.2.0

• Added support for streaming annotations in agents.stream_agent_response
• Added support for rendering container_file_citation in agents.stream_agent_response

v1.1.2

• IconName and WidgetIcon support vendor: prefixed icon names

v1.1.1

• Fix chatkit.__version__ to correctly read openai-chatkit metadata

v1.1.0

• Fix thread persistence (store now receives ThreadMetadata correctly).
• Drop Python 3.11-only features. Now works cleanly on Python 3.10.
• Allow the payload field on Action to be undefined by defaulting to None

Breaking:

• Restrict the icon field on CustomSummary, CustomTask, and EntitySource types to IconName (previously str).
• Update all ThreadItemConverter methods to be asynchronous.