Change8

v2.2.0rc1

Breaking Changes
📦 mistral-clientView on GitHub →
4 breaking16 features🔧 48 symbols

Summary

This release introduces extensive new functionality for Workflows, including execution, scheduling, runs, and event handling, alongside several breaking changes to existing model and connector response structures.

⚠️ Breaking Changes

  • The response structure for `mistral.models.list()` has changed, specifically concerning `response.data[].union(fine-tuned).job`.
  • The response structure for `mistral.beta.connectors.list_tools()` has changed.
  • The response structure for `mistral.models.update()` has changed.
  • The response structure for `mistral.models.retrieve()` has changed, specifically concerning `response.union(fine-tuned).job`.

Migration Steps

  1. Review and update code referencing the response structure of `mistral.models.list()` due to changes in `response.data[].union(fine-tuned).job`.
  2. Review and update code referencing the response structure of `mistral.beta.connectors.list_tools()`.
  3. Review and update code referencing the response structure of `mistral.models.update()`.
  4. Review and update code referencing the response structure of `mistral.models.retrieve()` due to changes in `response.union(fine-tuned).job`.
  5. Review the request structure for `mistral.beta.libraries.list()`.
  6. Handle potential 422 status errors in the response from `mistral.beta.libraries.list()`.
  7. Update calls to `mistral.beta.connectors.call_tool()` to optionally include `request.credentials_name`.

✨ New Features

  • Added support for retrieving workflow metrics via `mistral.workflows.metrics.get_workflow_metrics()`.
  • Added endpoints for managing workflows: `mistral.workflows.get_workflow()`, `mistral.workflows.update_workflow()`, `mistral.workflows.get_workflow_registration()`, `mistral.workflows.archive_workflow()`, and `mistral.workflows.unarchive_workflow()`.
  • Added endpoints for managing workflow executions, including retrieval, signaling, termination, cancellation, resetting, updating, and tracing: `mistral.workflows.executions.get_workflow_execution()`, `mistral.workflows.executions.get_workflow_execution_history()`, `mistral.workflows.executions.signal_workflow_execution()`, `mistral.workflows.executions.query_workflow_execution()`, `mistral.workflows.executions.terminate_workflow_execution()`, `mistral.workflows.executions.batch_terminate_workflow_executions()`, `mistral.workflows.executions.cancel_workflow_execution()`, `mistral.workflows.executions.batch_cancel_workflow_executions()`, `mistral.workflows.executions.reset_workflow()`, `mistral.workflows.executions.update_workflow_execution()`, `mistral.workflows.executions.get_workflow_execution_trace_otel()`, `mistral.workflows.executions.get_workflow_execution_trace_summary()`, `mistral.workflows.executions.get_workflow_execution_trace_events()`, and `mistral.workflows.executions.stream()`.
  • Added endpoints for managing workflow runs: `mistral.workflows.runs.get_run()` and `mistral.workflows.runs.list_runs()`, and run history: `mistral.workflows.runs.get_run_history()`.
  • Added endpoint for batch job deletion: `mistral.batch.jobs.delete()`.
  • Added endpoints for managing workflow schedules: `mistral.workflows.schedules.get_schedules()`, `mistral.workflows.schedules.schedule_workflow()`, and `mistral.workflows.schedules.unschedule_workflow()`.
  • Added endpoints for receiving and retrieving workflow events: `mistral.workflows.events.receive_workflow_event()`, `mistral.workflows.events.receive_workflow_events_batch()`, `mistral.workflows.events.get_stream_events()`, and `mistral.workflows.events.get_workflow_events()`.
  • Added endpoints for listing and retrieving workflow deployments: `mistral.workflows.deployments.list_deployments()` and `mistral.workflows.deployments.get_deployment()`.
  • Added duplicate endpoints for receiving and retrieving events under `mistral.events`: `mistral.events.receive_workflow_event()`, `mistral.events.receive_workflow_events_batch()`, `mistral.events.get_stream_events()`, and `mistral.events.get_workflow_events()`.
  • Added optional `request.type` parameter to `mistral.audio.voices.list()`.
  • Added endpoints for executing workflow registrations and workflows: `mistral.workflows.execute_workflow_registration()` and `mistral.workflows.execute_workflow()`.
  • Added endpoint to list workflow registrations: `mistral.workflows.get_workflow_registrations()`.
  • Added `response.pagination` to `mistral.beta.libraries.list()` response.
  • Added `error.status[422]` handling to `mistral.beta.libraries.list()`.
  • Added `request.credentials_name` parameter to `mistral.beta.connectors.call_tool()`.
  • Added endpoint to list all workflows: `mistral.workflows.get_workflows()`.

Affected Symbols

mistral.models.listmistral.beta.connectors.list_toolsmistral.models.updatemistral.models.retrievemistral.workflows.metrics.get_workflow_metricsmistral.workflows.get_workflowmistral.workflows.update_workflowmistral.workflows.get_workflow_registrationmistral.workflows.archive_workflowmistral.workflows.unarchive_workflowmistral.workflows.executions.get_workflow_executionmistral.workflows.executions.get_workflow_execution_historymistral.workflows.executions.signal_workflow_executionmistral.workflows.executions.query_workflow_executionmistral.workflows.executions.terminate_workflow_executionmistral.workflows.executions.batch_terminate_workflow_executionsmistral.workflows.executions.cancel_workflow_executionmistral.workflows.executions.batch_cancel_workflow_executionsmistral.workflows.executions.reset_workflowmistral.workflows.executions.update_workflow_executionmistral.workflows.executions.get_workflow_execution_trace_otelmistral.workflows.executions.get_workflow_execution_trace_summarymistral.workflows.executions.get_workflow_execution_trace_eventsmistral.workflows.executions.streammistral.workflows.runs.get_runmistral.batch.jobs.deletemistral.workflows.runs.list_runsmistral.workflows.runs.get_run_historymistral.workflows.schedules.get_schedulesmistral.workflows.schedules.schedule_workflowmistral.workflows.schedules.unschedule_workflowmistral.workflows.events.receive_workflow_eventmistral.workflows.events.receive_workflow_events_batchmistral.workflows.events.get_stream_eventsmistral.workflows.events.get_workflow_eventsmistral.workflows.deployments.list_deploymentsmistral.workflows.deployments.get_deploymentmistral.events.receive_workflow_eventmistral.events.receive_workflow_events_batchmistral.events.get_stream_eventsmistral.events.get_workflow_eventsmistral.audio.voices.listmistral.workflows.execute_workflow_registrationmistral.workflows.execute_workflowmistral.workflows.get_workflow_registrationsmistral.beta.libraries.listmistral.beta.connectors.call_toolmistral.workflows.get_workflows
mistral-client v2.2.0rc1 - Change8