Skip to content

Releases: openai/chatkit-python

v1.4.0

25 Nov 21:02
616a60d

Choose a tag to compare

  • 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

21 Nov 21:21
b925d14

Choose a tag to compare

  • 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

18 Nov 18:18

Choose a tag to compare

  • Fix type for Checkbox defaultChecked

v1.2.0

13 Nov 20:45
8bdadc4

Choose a tag to compare

  • 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

07 Nov 22:15
5c528d0

Choose a tag to compare

  • IconName and WidgetIcon support vendor: prefixed icon names

v1.1.1

06 Nov 21:34
22ffc00

Choose a tag to compare

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

v1.1.0

03 Nov 22:49
a6c216b

Choose a tag to compare

  • 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.

v1.0.2

09 Oct 21:28
a231f62

Choose a tag to compare

  • Loosen the type of chatkit.agents.ClientToolCall.arguments from dict[str, str] to dict[str, Any]. ClientToolCall.arguments can be any JSON serializable object.

v1.0.1

08 Oct 21:50
701dd0c

Choose a tag to compare

  • EntitySource includes an optional data dict that will be piped through onClick and onRequestPreview client-side callbacks

Initial release

08 Oct 18:14
590b7b1

Choose a tag to compare

Merge pull request #14 from openai/jiwon/bump-version

1.0.0 version bump