openai/chatkit-python
Publicmirrored fromhttps://github.com/openai/chatkit-pythonAvailable
docs/release.md
49lines · modecode
| 1 | # Release process/changelog |
| 2 | |
| 3 | The project follows a slightly modified version of [semantic versioning](https://semver.org/spec/v2.0.0.html). The SDK is still evolving and certain backwards-incompatible changes may be released as minor versions. |
| 4 | |
| 5 | For full release notes, see [https://github.com/openai/chatkit-python/releases](https://github.com/openai/chatkit-python/releases). |
| 6 | |
| 7 | ## Minor versions |
| 8 | |
| 9 | We will increase minor versions for **breaking changes** to any public interfaces. For example, going from `1.0.x` to `1.1.x` might include breaking changes. |
| 10 | |
| 11 | If you don't want breaking changes, we recommend pinning to `1.0.x` versions in your project. |
| 12 | |
| 13 | ## Patch versions |
| 14 | |
| 15 | We will increment patch versions for non-breaking changes: |
| 16 | |
| 17 | - Bug fixes |
| 18 | - New features |
| 19 | - Changes to private interfaces |
| 20 | |
| 21 | ## Breaking change changelog |
| 22 | |
| 23 | ### 1.5.0 |
| 24 | |
| 25 | Two-phase uploads: |
| 26 | |
| 27 | - `upload_url` was removed from `FileAttachment` and `ImageAttachment`; use `upload_descriptor` instead. |
| 28 | - `ChatKitServer` now saves the created attachment metadata in the store when handling the `attachments.create` request; remove the store-write step in `AttachmentStore.create_attachment`. |
| 29 | |
| 30 | |
| 31 | ### 1.4.0 |
| 32 | |
| 33 | - Widget and action classes are still usable but marked as deprecated in favor of using `WidgetTemplate` to build widgets from `.widget` files. |
| 34 | - Added `jinja2` as a required dependency for widget template rendering. |
| 35 | - A stop button is now shown by default during streaming, allowing users to cancel the stream mid-response. Integrations can override `ChatKitServer.get_stream_options` to change this behavior. |
| 36 | |
| 37 | ### 1.3.0 |
| 38 | |
| 39 | - Fixed the type for the `defaultChecked` property of `Checkbox` widgets, updating it from `string` to `bool`. |
| 40 | |
| 41 | ### 1.2.0 |
| 42 | |
| 43 | - Updated `agents.stream_agent_response` to add annotation parts as they are received rather than adding all the annotations at the end after the response is completed. |
| 44 | - Added support for rendering `container_file_citation`. |
| 45 | |
| 46 | ### 1.1.0 |
| 47 | |
| 48 | - `CustomSummary`, `CustomTask`, and `EntitySource` types have been updated to restrict `icon` to `IconName`. |
| 49 | - All `ThreadItemConverter` methods have been updated to be asynchronous. |