v2.2.0rc2
Breaking Changes📦 mistral-clientView on GitHub →
⚠ 2 breaking✨ 5 features🔧 11 symbols
Summary
This release introduces several new functions for sending events and worker status checks, while simultaneously removing all functions related to receiving workflow events, resulting in breaking changes.
⚠️ Breaking Changes
- The functions `mistral.workflows.events.receive_workflow_event()`, `mistral.workflows.events.receive_workflow_events_batch()`, `mistral.events.receive_workflow_event()`, and `mistral.events.receive_workflow_events_batch()` have been removed. Consumers should migrate to the newly added send functions or use alternative event handling mechanisms.
- The functions for receiving workflow events have been removed, which will break existing code relying on them.
Migration Steps
- If you were using `mistral.workflows.events.receive_workflow_event()`, `mistral.workflows.events.receive_workflow_events_batch()`, `mistral.events.receive_workflow_event()`, or `mistral.events.receive_workflow_events_batch()`, you must find an alternative way to receive workflow events as these functions have been removed.
- When calling `mistral.workflows.executions.get_workflow_execution_history()`, the new optional parameter `request.decode_payloads` is now available.
- When calling `mistral.workflows.runs.get_run_history()`, the new optional parameter `request.decode_payloads` is now available.
✨ New Features
- Added `mistral.workflows.workers.whoami()`.
- Added `mistral.workflows.events.send_event()`.
- Added `mistral.workflows.events.send_events_batch()`.
- Added `mistral.events.send_event()`.
- Added `mistral.events.send_events_batch()`.
Affected Symbols
mistral.workflows.workers.whoamimistral.workflows.events.send_eventmistral.workflows.events.send_events_batchmistral.events.send_eventmistral.events.send_events_batchmistral.workflows.events.receive_workflow_eventmistral.workflows.events.receive_workflow_events_batchmistral.events.receive_workflow_eventmistral.events.receive_workflow_events_batchmistral.workflows.executions.get_workflow_execution_historymistral.workflows.runs.get_run_history