Skip to content

fix: correct inaccurate migration guide documentation #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
louis-sanna-dev merged 1 commit into from
Feb 26, 2026
+5 −28
Merged

fix: correct inaccurate migration guide documentation #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 5 additions & 28 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,41 +46,16 @@ Azure and GCP SDKs now live under the `mistralai` namespace as separate distribu

#### Installation Changes

| v1 | v2 |
|---|---|
| `pip install mistralai` | `pip install mistralai` (includes Azure and GCP) |
| `pip install mistralai[gcp]` (for GCP auth) | `pip install "mistralai[gcp]"` (for GCP auth dependencies) |
The main `mistralai` package now bundles Azure and GCP support. You can also install `mistralai-azure` or `mistralai-gcp` as standalone distributions.
Copy link
Contributor

@Nelson-PROIA Nelson-PROIA Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No you can't, I'm surprised it generated that? "You can also install mistralai-azure or mistralai-gcp as standalone distributions."

Copy link
Contributor Author

@louis-sanna-dev louis-sanna-dev Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Nelson-PROIA ah. Thanks for catch, let's me fix it.


Azure and GCP are now standalone distributions that can be installed independently of the core SDK. The `mistralai[azure]` and `mistralai[gcp]` extras are syntactic sugar that pull in the respective distributions.
For GCP authentication dependencies, use `pip install "mistralai[gcp]"`.

### What Stays the Same

- The `Mistral` client API is unchanged
- All models (`UserMessage`, `AssistantMessage`, etc.) work the same way

### Type Name Changes

Some type names have been updated for clarity and consistency:

| Old Name | New Name |
|---|---|
| `Tools` | `ConversationRequestTool` |
| `ToolsTypedDict` | `ConversationRequestToolTypedDict` |
| `HandoffExecution` | `ConversationRequestHandoffExecution` |
| `AgentVersion` | `ConversationRequestAgentVersion` |

### Shorter Request/Response Class Names

Internal request and response wrapper classes now use concise names:

| Old Name | New Name |
|---|---|
| `JobsAPIRoutesFineTuningArchiveFineTunedModelRequest` | `ArchiveModelRequest` |
| `JobsAPIRoutesFineTuningCreateFineTuningJobResponse` | `CreateFineTuningJobResponse` |
| `FilesAPIRoutesUploadFileRequest` | `UploadFileRequest` |
| `AgentsAPIV1ConversationsAppendRequest` | `AppendConversationRequest` |

This affects all operation-specific request/response types. Core models like `UserMessage`, `ChatCompletionRequest`, etc. are unchanged.
### Enums

Enums now accept unknown values for forward compatibility with API changes.

Expand All @@ -90,6 +65,8 @@ Enums now accept unknown values for forward compatibility with API changes.

Version 1.0 introduced significant changes to improve usability and consistency.

> **Note:** The v1.x examples below use v1-style imports (e.g., `from mistralai import Mistral`). If you're on v2.x, combine these API changes with the [v1 to v2 import changes](#migrating-from-v1x-to-v2x) above.

### Major Changes

1. **Unified Client Class**: `MistralClient` and `MistralAsyncClient` consolidated into a single `Mistral` class
Expand Down