openai/chatkit-python
Publicmirrored from https://github.com/openai/chatkit-pythonAvailable
docs/release.md
52lines · modeblame
7327b5dbJiwon Kim8 months ago | 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 | | |
e0747eecJiwon Kim6 months ago | 5 | For full release notes, see [https://github.com/openai/chatkit-python/releases](https://github.com/openai/chatkit-python/releases). |
| 6 | | |
7327b5dbJiwon Kim8 months ago | 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 | | |
2d5dc36dJiwon Kim5 months ago | 23 | ### 1.6.0 |
| 24 | | |
| 25 | - `Store.save_attachment` may now be called with updates to existing attachments (treated as an upsert), not only inserts. | |
| 26 | | |
0a12d2fcJiwon Kim6 months ago | 27 | ### 1.5.0 |
| 28 | | |
| 29 | Two-phase uploads: | |
| 30 | | |
| 31 | - `upload_url` was removed from `FileAttachment` and `ImageAttachment`; use `upload_descriptor` instead. | |
| 32 | - `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`. | |
| 33 | | |
b77d8564Jiwon Kim7 months ago | 34 | ### 1.4.0 |
| 35 | | |
| 36 | - Widget and action classes are still usable but marked as deprecated in favor of using `WidgetTemplate` to build widgets from `.widget` files. | |
| 37 | - Added `jinja2` as a required dependency for widget template rendering. | |
| 38 | - 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. | |
| 39 | | |
888bb98cYOUR NAME8 months ago | 40 | ### 1.3.0 |
7327b5dbJiwon Kim8 months ago | 41 | |
888bb98cYOUR NAME8 months ago | 42 | - Fixed the type for the `defaultChecked` property of `Checkbox` widgets, updating it from `string` to `bool`. |
3059bb70YOUR NAME8 months ago | 43 | |
| 44 | ### 1.2.0 | |
| 45 | | |
| 46 | - 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. | |
| 47 | - Added support for rendering `container_file_citation`. | |
| 48 | | |
888bb98cYOUR NAME8 months ago | 49 | ### 1.1.0 |
3059bb70YOUR NAME8 months ago | 50 | |
888bb98cYOUR NAME8 months ago | 51 | - `CustomSummary`, `CustomTask`, and `EntitySource` types have been updated to restrict `icon` to `IconName`. |
| 52 | - All `ThreadItemConverter` methods have been updated to be asynchronous. |