mistralai 1.0.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

{mistralai-1.0.3.dist-info → mistralai-1.2.0.dist-info}/METADATA

@@ -1,7 +1,8 @@
 Metadata-Version: 2.1
 Name: mistralai
-Version: 1.0.3
+Version: 1.2.0
 Summary: Python Client SDK for the Mistral AI API.
+Home-page: https://github.com/mistralai/client-python.git
 Author: Mistral
 Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -10,21 +11,24 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: gcp
+Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
 Requires-Dist: google-auth (==2.27.0) ; extra == "gcp"
 Requires-Dist: httpx (>=0.27.0,<0.28.0)
 Requires-Dist: jsonpath-python (>=1.0.6,<2.0.0)
-Requires-Dist: pydantic (>=2.8.2,<2.9.0)
-Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: pydantic (>=2.9.0,<3.0.0)
+Requires-Dist: python-dateutil (==2.8.2)
 Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "gcp"
 Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
+Project-URL: Repository, https://github.com/mistralai/client-python.git
 Description-Content-Type: text/markdown
 
 # Mistral Python Client
 
 ## Migration warning
  
-This documentation is for Mistral AI SDK v1. You can find more details on how to migrate from v0 to v1 [here](MIGRATION.md)
+This documentation is for Mistral AI SDK v1. You can find more details on how to migrate from v0 to v1 [here](https://github.com/mistralai/client-python/blob/master/MIGRATION.md)
 
 ## API Key Setup
 
@@ -41,15 +45,46 @@ $ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv
 $ source ~/.zshenv
 ```
 
+<!-- Start Summary [summary] -->
+## Summary
+
+Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [SDK Installation](https://github.com/mistralai/client-python/blob/master/#sdk-installation)
+* [IDE Support](https://github.com/mistralai/client-python/blob/master/#ide-support)
+* [SDK Example Usage](https://github.com/mistralai/client-python/blob/master/#sdk-example-usage)
+* [Available Resources and Operations](https://github.com/mistralai/client-python/blob/master/#available-resources-and-operations)
+* [Server-sent event streaming](https://github.com/mistralai/client-python/blob/master/#server-sent-event-streaming)
+* [File uploads](https://github.com/mistralai/client-python/blob/master/#file-uploads)
+* [Retries](https://github.com/mistralai/client-python/blob/master/#retries)
+* [Error Handling](https://github.com/mistralai/client-python/blob/master/#error-handling)
+* [Server Selection](https://github.com/mistralai/client-python/blob/master/#server-selection)
+* [Custom HTTP Client](https://github.com/mistralai/client-python/blob/master/#custom-http-client)
+* [Authentication](https://github.com/mistralai/client-python/blob/master/#authentication)
+* [Debugging](https://github.com/mistralai/client-python/blob/master/#debugging)
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-PIP
+The SDK can be installed with either *pip* or *poetry* package managers.
+
+### PIP
+
+*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
+
 ```bash
 pip install mistralai
 ```
 
-Poetry
+### Poetry
+
+*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
+
 ```bash
 poetry add mistralai
 ```
@@ -71,7 +106,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.chat.complete(model="mistral-small-latest", messages=[
     {
         "content": "Who is the best French painter? Answer in one short sentence.",
@@ -123,10 +157,9 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.files.upload(file={
-    "file_name": "your_file_here",
-    "content": open("<file_path>", "rb"),
+    "file_name": "example.file",
+    "content": open("example.file", "rb"),
 })
 
 if res is not None:
@@ -148,8 +181,8 @@ async def main():
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     )
     res = await s.files.upload_async(file={
-        "file_name": "your_file_here",
-        "content": open("<file_path>", "rb"),
+        "file_name": "example.file",
+        "content": open("example.file", "rb"),
     })
     if res is not None:
         # handle response
@@ -171,7 +204,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.agents.complete(messages=[
     {
         "content": "Who is the best French painter? Answer in one short sentence.",
@@ -207,6 +239,53 @@ async def main():
         # handle response
         pass
 
+asyncio.run(main())
+```
+
+### Create Embedding Request
+
+This example shows how to create embedding request.
+
+```python
+# Synchronous Example
+from mistralai import Mistral
+import os
+
+s = Mistral(
+    api_key=os.getenv("MISTRAL_API_KEY", ""),
+)
+
+res = s.embeddings.create(inputs=[
+    "Embed this sentence.",
+    "As well as this one.",
+], model="Wrangler")
+
+if res is not None:
+    # handle response
+    pass
+```
+
+</br>
+
+The same SDK client can also be used to make asychronous requests by importing asyncio.
+```python
+# Asynchronous Example
+import asyncio
+from mistralai import Mistral
+import os
+
+async def main():
+    s = Mistral(
+        api_key=os.getenv("MISTRAL_API_KEY", ""),
+    )
+    res = await s.embeddings.create_async(inputs=[
+        "Embed this sentence.",
+        "As well as this one.",
+    ], model="Wrangler")
+    if res is not None:
+        # handle response
+        pass
+
 asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
@@ -226,7 +305,7 @@ You can run the examples in the `examples/` directory using `poetry run` or by e
 Before you begin, ensure you have `AZUREAI_ENDPOINT` and an `AZURE_API_KEY`. To obtain these, you will need to deploy Mistral on Azure AI.
 See [instructions for deploying Mistral on Azure AI here](https://docs.mistral.ai/deployment/cloud/azure/).
 
-Here's a basic example to get you started. You can also run [the example in the `examples` directory](/examples/azure).
+Here's a basic example to get you started. You can also run [the example in the `examples` directory](https://github.com/mistralai/client-python/blob/master//examples/azure).
 
 ```python
 import asyncio
@@ -254,7 +333,7 @@ async def main() -> None:
 
 asyncio.run(main())
 ```
-The documentation for the Azure SDK is available [here](packages/mistralai_azure/README.md).
+The documentation for the Azure SDK is available [here](https://github.com/mistralai/client-python/blob/master/packages/mistralai_azure/README.md).
 
 ### Google Cloud
 
@@ -303,55 +382,79 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-The documentation for the GCP SDK is available [here](packages/mistralai_gcp/README.md).
+The documentation for the GCP SDK is available [here](https://github.com/mistralai/client-python/blob/master/packages/mistralai_gcp/README.md).
 
 
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [models](docs/sdks/models/README.md)
+<details open>
+<summary>Available methods</summary>
+
+### [agents](https://github.com/mistralai/client-python/blob/master/docs/sdks/agents/README.md)
+
+* [complete](https://github.com/mistralai/client-python/blob/master/docs/sdks/agents/README.md#complete) - Agents Completion
+* [stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/agents/README.md#stream) - Stream Agents completion
+
+### [batch](https://github.com/mistralai/client-python/blob/master/docs/sdks/batch/README.md)
 
-* [list](docs/sdks/models/README.md#list) - List Models
-* [retrieve](docs/sdks/models/README.md#retrieve) - Retrieve Model
-* [delete](docs/sdks/models/README.md#delete) - Delete Model
-* [update](docs/sdks/models/README.md#update) - Update Fine Tuned Model
-* [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
-* [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
 
-### [files](docs/sdks/files/README.md)
+#### [batch.jobs](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md)
 
-* [upload](docs/sdks/files/README.md#upload) - Upload File
-* [list](docs/sdks/files/README.md#list) - List Files
-* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File
-* [delete](docs/sdks/files/README.md#delete) - Delete File
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs
+* [create](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#create) - Create Batch Job
+* [get](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#get) - Get Batch Job
+* [cancel](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch Job
 
+### [chat](https://github.com/mistralai/client-python/blob/master/docs/sdks/chat/README.md)
 
-### [fine_tuning.jobs](docs/sdks/jobs/README.md)
+* [complete](https://github.com/mistralai/client-python/blob/master/docs/sdks/chat/README.md#complete) - Chat Completion
+* [stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/chat/README.md#stream) - Stream chat completion
 
-* [list](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs
-* [create](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job
-* [get](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job
-* [cancel](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job
-* [start](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job
+### [classifiers](https://github.com/mistralai/client-python/blob/master/docs/sdks/classifiers/README.md)
 
-### [chat](docs/sdks/chat/README.md)
+* [moderate](https://github.com/mistralai/client-python/blob/master/docs/sdks/classifiers/README.md#moderate) - Moderations
+* [moderate_chat](https://github.com/mistralai/client-python/blob/master/docs/sdks/classifiers/README.md#moderate_chat) - Moderations Chat
 
-* [complete](docs/sdks/chat/README.md#complete) - Chat Completion
-* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion
+### [embeddings](https://github.com/mistralai/client-python/blob/master/docs/sdks/embeddings/README.md)
 
-### [fim](docs/sdks/fim/README.md)
+* [create](https://github.com/mistralai/client-python/blob/master/docs/sdks/embeddings/README.md#create) - Embeddings
 
-* [complete](docs/sdks/fim/README.md#complete) - Fim Completion
-* [stream](docs/sdks/fim/README.md#stream) - Stream fim completion
+### [files](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md)
 
-### [agents](docs/sdks/agents/README.md)
+* [upload](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#upload) - Upload File
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#list) - List Files
+* [retrieve](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#retrieve) - Retrieve File
+* [delete](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#delete) - Delete File
+* [download](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#download) - Download File
 
-* [complete](docs/sdks/agents/README.md#complete) - Agents Completion
-* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion
+### [fim](https://github.com/mistralai/client-python/blob/master/docs/sdks/fim/README.md)
 
-### [embeddings](docs/sdks/embeddings/README.md)
+* [complete](https://github.com/mistralai/client-python/blob/master/docs/sdks/fim/README.md#complete) - Fim Completion
+* [stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/fim/README.md#stream) - Stream fim completion
 
-* [create](docs/sdks/embeddings/README.md#create) - Embeddings
+### [fine_tuning](https://github.com/mistralai/client-python/blob/master/docs/sdks/finetuning/README.md)
+
+
+#### [fine_tuning.jobs](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md)
+
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs
+* [create](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md#create) - Create Fine Tuning Job
+* [get](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md#get) - Get Fine Tuning Job
+* [cancel](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job
+* [start](https://github.com/mistralai/client-python/blob/master/docs/sdks/jobs/README.md#start) - Start Fine Tuning Job
+
+
+### [models](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md)
+
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#list) - List Models
+* [retrieve](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#retrieve) - Retrieve Model
+* [delete](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#delete) - Delete Model
+* [update](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#update) - Update Fine Tuned Model
+* [archive](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
+* [unarchive](https://github.com/mistralai/client-python/blob/master/docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Server-sent event streaming [eventstream] -->
@@ -371,7 +474,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.chat.stream(model="mistral-small-latest", messages=[
     {
         "content": "Who is the best French painter? Answer in one short sentence.",
@@ -408,10 +510,9 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.files.upload(file={
-    "file_name": "your_file_here",
-    "content": open("<file_path>", "rb"),
+    "file_name": "example.file",
+    "content": open("example.file", "rb"),
 })
 
 if res is not None:
@@ -436,7 +537,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.models.list(,
     RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
@@ -457,7 +557,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.models.list()
 
 if res is not None:
@@ -470,12 +569,23 @@ if res is not None:
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
+
+By default, an API error will raise a models.SDKError exception, which has the following properties:
+
+| Property        | Type             | Description           |
+|-----------------|------------------|-----------------------|
+| `.status_code`  | *int*            | The HTTP status code  |
+| `.message`      | *str*            | The error message     |
+| `.raw_response` | *httpx.Response* | The raw HTTP response |
+| `.body`         | *str*            | The response content  |
+
+When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `list_async` method may raise the following exceptions:
 
-| Error Object               | Status Code                | Content Type               |
+| Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | models.HTTPValidationError | 422                        | application/json           |
-| models.SDKError            | 4xx-5xx                    | */*                        |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
 ### Example
 
@@ -491,17 +601,16 @@ res = None
 try:
     res = s.models.list()
 
+    if res is not None:
+        # handle response
+        pass
+
 except models.HTTPValidationError as e:
-    # handle exception
+    # handle e.data: models.HTTPValidationErrorData
     raise(e)
 except models.SDKError as e:
     # handle exception
     raise(e)
-
-if res is not None:
-    # handle response
-    pass
-
 ```
 <!-- End Error Handling [errors] -->
 
@@ -514,7 +623,7 @@ You can override the default server globally by passing a server name to the `se
 
 | Name | Server | Variables |
 | ----- | ------ | --------- |
-| `prod` | `https://api.mistral.ai` | None |
+| `eu` | `https://api.mistral.ai` | None |
 
 #### Example
 
@@ -523,11 +632,10 @@ from mistralai import Mistral
 import os
 
 s = Mistral(
-    server="prod",
+    server="eu",
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.models.list()
 
 if res is not None:
@@ -549,7 +657,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.models.list()
 
 if res is not None:
@@ -660,7 +767,6 @@ s = Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 )
 
-
 res = s.models.list()
 
 if res is not None:
@@ -705,4 +811,3 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
 We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
-