●Change8

v2.4.1

Breaking Changes
📦 mistral-clientView on GitHub →
⚠ 22 breaking✨ 12 features🔧 65 symbols

Summary

This release introduces significant structural changes across many beta and workflow API endpoints, including modifications to request parameters and response schemas, alongside the addition of numerous new connector management and workflow-related endpoints.

⚠️ Breaking Changes

  • `mistral.beta.conversations.restart_stream()`: The `request` parameter has changed.
  • `mistral.workflows.executions.get_workflow_execution_trace_events()`: The `response` structure has changed.
  • `mistral.workflows.executions.get_workflow_execution_trace_summary()`: The `response` structure has changed.
  • `mistral.workflows.executions.get_workflow_execution_trace_otel()`: The `response` structure has changed.
  • `mistral.beta.connectors.update()`: `response.tools` field has been removed.
  • `mistral.beta.connectors.get()`: `response.tools` field has been removed.
  • `mistral.beta.connectors.list()`: `response.items[].tools` field has been removed.
  • `mistral.beta.connectors.create()`: `response.tools` field has been removed.
  • `mistral.beta.agents.get_version()`: `response.metadata` structure has changed.
  • `mistral.beta.agents.list_versions()`: `response.[].metadata` structure has changed.
  • `mistral.beta.agents.update_version()`: `response.metadata` structure has changed.
  • `mistral.audio.speech.complete()`: `request.metadata` structure has changed.
  • `mistral.audio.voices.get_sample_audio()`: `response.status[200]` structure has changed.
  • `mistral.beta.conversations.start()`: The `request` parameter has changed.
  • `mistral.beta.conversations.list()`: `response.[]` structure has changed.
  • `mistral.beta.conversations.get()`: `response` structure has changed.
  • `mistral.beta.agents.update()`: `request.metadata` and `response.metadata` structures have changed.
  • `mistral.beta.agents.get()`: `response.metadata` structure has changed.
  • `mistral.beta.agents.list()`: `response.[].metadata` structure has changed.
  • `mistral.beta.conversations.restart()`: The `request` parameter has changed.
  • `mistral.beta.conversations.start_stream()`: The `request` parameter has changed.
  • `mistral.beta.agents.create()`: `request.metadata` and `response.metadata` structures have changed.

Migration Steps

  1. Review changes to request parameters for `mistral.beta.conversations.restart_stream`, `mistral.beta.conversations.start`, `mistral.beta.conversations.restart`, and `mistral.beta.conversations.start_stream` as the `request` object structure has been modified.
  2. Update code handling responses from `mistral.workflows.executions.get_workflow_execution_trace_events`, `...get_workflow_execution_trace_summary`, and `...get_workflow_execution_trace_otel` due to response structure changes.
  3. Remove usage of `response.tools` from results of `mistral.beta.connectors.update`, `get`, `list`, and `create`.
  4. Update code expecting metadata fields in agent version/agent operations (`get_version`, `list_versions`, `update_version`, `update`, `get`, `list`, `create`) as the structure of `metadata` has changed.
  5. Update handling of `mistral.audio.speech.complete` requests to reflect changes in `request.metadata`.
  6. Update handling of `mistral.audio.voices.get_sample_audio` responses based on changes to `response.status[200]`.

✨ New Features

  • Added `signature` field to various content/output chunks across conversation and model completion endpoints (e.g., `mistral.beta.conversations.restart_stream`, `mistral.chat.complete`).
  • Added new endpoints for Connector management: `mistral.beta.connectors.get_authentication_methods`, `mistral.beta.connectors.delete_user_credentials`, `mistral.beta.connectors.delete_workspace_credentials`, `mistral.beta.connectors.delete_organization_credentials`, `mistral.beta.connectors.create_or_update_user_credentials`, `mistral.beta.connectors.get_auth_url`, `mistral.beta.connectors.list_tools`, `mistral.beta.connectors.list_user_credentials`, `mistral.beta.connectors.create_or_update_workspace_credentials`, `mistral.beta.connectors.list_workspace_credentials`, `mistral.beta.connectors.create_or_update_organization_credentials`, `mistral.beta.connectors.list_organization_credentials`.
  • Added RAG ingestion pipeline configuration listing: `mistral.beta.rag.ingestion_pipeline_configurations.list()`.
  • Added `owner_type` to `mistral.beta.libraries.create()` request.
  • Added `map` enum type definition to observability fields: `mistral.beta.observability.chat_completion_events.fields.list()`.
  • Added `request` parameter `credentials_name` to connector listing/auth URL endpoints.
  • Added `request` parameter `extensions` to workflow execution endpoints: `mistral.workflows.execute_workflow()` and `mistral.workflows.execute_workflow_registration()`.
  • Added `run_id` to workflow execution responses: `mistral.workflows.execute_workflow()`, `mistral.workflows.execute_workflow_registration()`, and workflow execution retrieval endpoints.
  • Added `on_behalf_of` field to workflow definitions: `mistral.workflows.get_workflow()`, `mistral.workflows.update_workflow()`, `mistral.workflows.archive_workflow()`, `mistral.workflows.unarchive_workflow()`.
  • Added `display_name` to workflow execution started events in streaming/event endpoints.
  • Added `user_id` filter to `mistral.workflows.runs.list_runs()`.
  • Added `location` to deployment listings: `mistral.workflows.deployments.list_deployments()`.

Affected Symbols

mistral.beta.conversations.restart_streammistral.workflows.executions.get_workflow_execution_trace_eventsmistral.workflows.executions.get_workflow_execution_trace_summarymistral.workflows.executions.get_workflow_execution_trace_otelmistral.beta.connectors.updatemistral.beta.connectors.getmistral.beta.connectors.listmistral.beta.connectors.createmistral.beta.agents.get_versionmistral.beta.agents.list_versionsmistral.beta.agents.update_versionmistral.audio.speech.completemistral.audio.voices.get_sample_audiomistral.beta.conversations.startmistral.beta.conversations.listmistral.beta.conversations.getmistral.beta.agents.updatemistral.beta.agents.getmistral.beta.agents.listmistral.beta.conversations.restartmistral.beta.conversations.start_streammistral.beta.agents.createmistral.beta.conversations.get_historymistral.classifiers.moderate_chatmistral.beta.conversations.get_messagesmistral.beta.connectors.get_authentication_methodsmistral.beta.conversations.appendmistral.beta.rag.ingestion_pipeline_configurations.listmistral.beta.connectors.delete_user_credentialsmistral.beta.connectors.delete_workspace_credentialsmistral.beta.libraries.createmistral.beta.libraries.documents.text_contentmistral.beta.observability.chat_completion_events.fields.listmistral.beta.connectors.delete_organization_credentialsmistral.beta.connectors.create_or_update_user_credentialsmistral.beta.connectors.get_auth_urlmistral.beta.connectors.list_toolsmistral.beta.connectors.list_user_credentialsmistral.beta.connectors.create_or_update_workspace_credentialsmistral.chat.completemistral.chat.streammistral.fim.completemistral.fim.streammistral.agents.completemistral.agents.streammistral.beta.conversations.append_streammistral.classifiers.classify_chatmistral.workflows.get_workflow_registrationsmistral.workflows.execute_workflowmistral.workflows.execute_workflow_registrationmistral.workflows.get_workflowmistral.workflows.update_workflowmistral.workflows.get_workflow_registrationmistral.workflows.archive_workflowmistral.workflows.unarchive_workflowmistral.workflows.executions.get_workflow_executionmistral.beta.connectors.list_workspace_credentialsmistral.beta.connectors.create_or_update_organization_credentialsmistral.beta.connectors.list_organization_credentialsmistral.workflows.executions.streammistral.workflows.runs.list_runsmistral.workflows.runs.get_runmistral.workflows.events.get_stream_eventsmistral.workflows.events.get_workflow_eventsmistral.workflows.deployments.list_deployments