Skip to content

Commit 11babe1

Browse files
fix: correct inaccurate migration guide documentation (#375)
- Remove false "Type Name Changes" section (claimed renamings don't exist) - Remove false "Shorter Request/Response Class Names" section (long names still used) - Simplify installation section with accurate info - Add clarifying note for v2 users reading v0->v1 section
1 parent 7cb12a9 commit 11babe1

1 file changed

Lines changed: 5 additions & 28 deletions

File tree

MIGRATION.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -46,41 +46,16 @@ Azure and GCP SDKs now live under the `mistralai` namespace as separate distribu
4646

4747
#### Installation Changes
4848

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

54-
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.
51+
For GCP authentication dependencies, use `pip install "mistralai[gcp]"`.
5552

5653
### What Stays the Same
5754

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

61-
### Type Name Changes
62-
63-
Some type names have been updated for clarity and consistency:
64-
65-
| Old Name | New Name |
66-
|---|---|
67-
| `Tools` | `ConversationRequestTool` |
68-
| `ToolsTypedDict` | `ConversationRequestToolTypedDict` |
69-
| `HandoffExecution` | `ConversationRequestHandoffExecution` |
70-
| `AgentVersion` | `ConversationRequestAgentVersion` |
71-
72-
### Shorter Request/Response Class Names
73-
74-
Internal request and response wrapper classes now use concise names:
75-
76-
| Old Name | New Name |
77-
|---|---|
78-
| `JobsAPIRoutesFineTuningArchiveFineTunedModelRequest` | `ArchiveModelRequest` |
79-
| `JobsAPIRoutesFineTuningCreateFineTuningJobResponse` | `CreateFineTuningJobResponse` |
80-
| `FilesAPIRoutesUploadFileRequest` | `UploadFileRequest` |
81-
| `AgentsAPIV1ConversationsAppendRequest` | `AppendConversationRequest` |
82-
83-
This affects all operation-specific request/response types. Core models like `UserMessage`, `ChatCompletionRequest`, etc. are unchanged.
58+
### Enums
8459

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

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

9166
Version 1.0 introduced significant changes to improve usability and consistency.
9267

68+
> **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.
69+
9370
### Major Changes
9471

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

0 commit comments

Comments
 (0)