mistralai 1.5.0__py3-none-any.whl → 1.5.2rc1__py3-none-any.whl

mistralai/sdk.py

@@ -17,6 +17,7 @@ from mistralai.files import Files
 from mistralai.fim import Fim
 from mistralai.fine_tuning import FineTuning
 from mistralai.models_ import Models
+from mistralai.ocr import Ocr
 from mistralai.types import OptionalNullable, UNSET
 from typing import Any, Callable, Dict, Optional, Union, cast
 import weakref
@@ -41,6 +42,8 @@ class Mistral(BaseSDK):
     r"""Embeddings API."""
     classifiers: Classifiers
     r"""Classifiers API."""
+    ocr: Ocr
+    r"""OCR API"""
 
     def __init__(
         self,
@@ -65,15 +68,19 @@ class Mistral(BaseSDK):
         :param retry_config: The retry configuration to use for all supported methods
         :param timeout_ms: Optional request timeout applied to each operation in milliseconds
         """
+        client_supplied = True
         if client is None:
             client = httpx.Client()
+            client_supplied = False
 
         assert issubclass(
             type(client), HttpClient
         ), "The provided client must implement the HttpClient protocol."
 
+        async_client_supplied = True
         if async_client is None:
             async_client = httpx.AsyncClient()
+            async_client_supplied = False
 
         if debug_logger is None:
             debug_logger = get_default_logger()
@@ -97,7 +104,9 @@ class Mistral(BaseSDK):
             self,
             SDKConfiguration(
                 client=client,
+                client_supplied=client_supplied,
                 async_client=async_client,
+                async_client_supplied=async_client_supplied,
                 security=security,
                 server_url=server_url,
                 server=server,
@@ -111,7 +120,7 @@ class Mistral(BaseSDK):
 
         current_server_url, *_ = self.sdk_configuration.get_server_details()
         server_url, self.sdk_configuration.client = hooks.sdk_init(
-            current_server_url, self.sdk_configuration.client
+            current_server_url, client
         )
         if current_server_url != server_url:
             self.sdk_configuration.server_url = server_url
@@ -124,7 +133,9 @@ class Mistral(BaseSDK):
             close_clients,
             cast(ClientOwner, self.sdk_configuration),
             self.sdk_configuration.client,
+            self.sdk_configuration.client_supplied,
             self.sdk_configuration.async_client,
+            self.sdk_configuration.async_client_supplied,
         )
 
         self._init_sdks()
@@ -139,6 +150,7 @@ class Mistral(BaseSDK):
         self.agents = Agents(self.sdk_configuration)
         self.embeddings = Embeddings(self.sdk_configuration)
         self.classifiers = Classifiers(self.sdk_configuration)
+        self.ocr = Ocr(self.sdk_configuration)
 
     def __enter__(self):
         return self
@@ -147,9 +159,17 @@ class Mistral(BaseSDK):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        if self.sdk_configuration.client is not None:
+        if (
+            self.sdk_configuration.client is not None
+            and not self.sdk_configuration.client_supplied
+        ):
             self.sdk_configuration.client.close()
+        self.sdk_configuration.client = None
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):
-        if self.sdk_configuration.async_client is not None:
+        if (
+            self.sdk_configuration.async_client is not None
+            and not self.sdk_configuration.async_client_supplied
+        ):
             await self.sdk_configuration.async_client.aclose()
+        self.sdk_configuration.async_client = None

mistralai/sdkconfiguration.py

@@ -26,8 +26,10 @@ SERVERS = {
 
 @dataclass
 class SDKConfiguration:
-    client: HttpClient
-    async_client: AsyncHttpClient
+    client: Union[HttpClient, None]
+    client_supplied: bool
+    async_client: Union[AsyncHttpClient, None]
+    async_client_supplied: bool
     debug_logger: Logger
     security: Optional[Union[models.Security, Callable[[], models.Security]]] = None
     server_url: Optional[str] = ""

mistralai/utils/__init__.py

@@ -43,6 +43,7 @@ from .values import (
     match_content_type,
     match_status_codes,
     match_response,
+    cast_partial,
 )
 from .logger import Logger, get_body_content, get_default_logger
 
@@ -96,4 +97,5 @@ __all__ = [
     "validate_float",
     "validate_int",
     "validate_open_enum",
+    "cast_partial",
 ]

mistralai/utils/serializers.py

@@ -7,14 +7,15 @@ import httpx
 from typing_extensions import get_origin
 from pydantic import ConfigDict, create_model
 from pydantic_core import from_json
-from typing_inspect import is_optional_type
+from typing_inspection.typing_objects import is_union
 
 from ..types.basemodel import BaseModel, Nullable, OptionalNullable, Unset
 
 
 def serialize_decimal(as_str: bool):
     def serialize(d):
-        if is_optional_type(type(d)) and d is None:
+        # Optional[T] is a Union[T, None]
+        if is_union(type(d)) and type(None) in get_args(type(d)) and d is None:
             return None
         if isinstance(d, Unset):
             return d
@@ -42,7 +43,8 @@ def validate_decimal(d):
 
 def serialize_float(as_str: bool):
     def serialize(f):
-        if is_optional_type(type(f)) and f is None:
+        # Optional[T] is a Union[T, None]
+        if is_union(type(f)) and type(None) in get_args(type(f)) and f is None:
             return None
         if isinstance(f, Unset):
             return f
@@ -70,7 +72,8 @@ def validate_float(f):
 
 def serialize_int(as_str: bool):
     def serialize(i):
-        if is_optional_type(type(i)) and i is None:
+        # Optional[T] is a Union[T, None]
+        if is_union(type(i)) and type(None) in get_args(type(i)) and i is None:
             return None
         if isinstance(i, Unset):
             return i
@@ -118,7 +121,8 @@ def validate_open_enum(is_int: bool):
 
 def validate_const(v):
     def validate(c):
-        if is_optional_type(type(c)) and c is None:
+        # Optional[T] is a Union[T, None]
+        if is_union(type(c)) and type(None) in get_args(type(c)) and c is None:
             return None
 
         if v != c:
@@ -163,7 +167,7 @@ def marshal_json(val, typ):
     if len(d) == 0:
         return ""
 
-    return json.dumps(d[next(iter(d))], separators=(",", ":"), sort_keys=True)
+    return json.dumps(d[next(iter(d))], separators=(",", ":"))
 
 
 def is_nullable(field):

mistralai/utils/values.py

@@ -3,8 +3,9 @@
 from datetime import datetime
 from enum import Enum
 from email.message import Message
+from functools import partial
 import os
-from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union
+from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union, cast
 
 from httpx import Response
 from pydantic import BaseModel
@@ -51,6 +52,8 @@ def match_status_codes(status_codes: List[str], status_code: int) -> bool:
 
 T = TypeVar("T")
 
+def cast_partial(typ):
+    return partial(cast, typ)
 
 def get_global_from_env(
     value: Optional[T], env_key: str, type_cast: Callable[[str], T]

{mistralai-1.5.0.dist-info → mistralai-1.5.2rc1.dist-info}/METADATA

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: mistralai
-Version: 1.5.0
+Version: 1.5.2rc1
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -14,12 +13,11 @@ Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: gcp
 Requires-Dist: eval-type-backport (>=0.2.0)
 Requires-Dist: google-auth (>=2.27.0) ; extra == "gcp"
-Requires-Dist: httpx (>=0.27.0)
-Requires-Dist: jsonpath-python (>=1.0.6)
-Requires-Dist: pydantic (>=2.9.0)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: pydantic (>=2.10.3)
 Requires-Dist: python-dateutil (>=2.8.2)
 Requires-Dist: requests (>=2.32.3) ; extra == "gcp"
-Requires-Dist: typing-inspect (>=0.9.0)
+Requires-Dist: typing-inspection (>=0.4.0)
 Project-URL: Repository, https://github.com/mistralai/client-python.git
 Description-Content-Type: text/markdown
 
@@ -100,6 +98,37 @@ pip install mistralai
 ```bash
 poetry add mistralai
 ```
+
+### Shell and script usage with `uv`
+
+You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
+
+```shell
+uvx --from mistralai python
+```
+
+It's also possible to write a standalone Python script without needing to set up a whole project like so:
+
+```python
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.9"
+# dependencies = [
+#     "mistralai",
+# ]
+# ///
+
+from mistralai import Mistral
+
+sdk = Mistral(
+  # SDK arguments
+)
+
+# Rest of script here...
+```
+
+Once that is saved to a file, you can run it with `uv run script.py` where
+`script.py` can be replaced with the actual file name.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start SDK Example Usage [usage] -->
@@ -114,6 +143,7 @@ This example shows how to create chat completions.
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -123,7 +153,7 @@ with Mistral(
             "content": "Who is the best French painter? Answer in one short sentence.",
             "role": "user",
         },
-    ], stream=False)
+    ])
 
     # Handle response
     print(res)
@@ -139,6 +169,7 @@ from mistralai import Mistral
 import os
 
 async def main():
+
     async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral:
@@ -148,7 +179,7 @@ async def main():
                 "content": "Who is the best French painter? Answer in one short sentence.",
                 "role": "user",
             },
-        ], stream=False)
+        ])
 
         # Handle response
         print(res)
@@ -165,6 +196,7 @@ This example shows how to upload a file.
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -188,6 +220,7 @@ from mistralai import Mistral
 import os
 
 async def main():
+
     async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral:
@@ -212,6 +245,7 @@ This example shows how to create agents completions.
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -221,7 +255,7 @@ with Mistral(
             "content": "Who is the best French painter? Answer in one short sentence.",
             "role": "user",
         },
-    ], agent_id="<id>", stream=False)
+    ], agent_id="<id>")
 
     # Handle response
     print(res)
@@ -237,6 +271,7 @@ from mistralai import Mistral
 import os
 
 async def main():
+
     async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral:
@@ -246,7 +281,7 @@ async def main():
                 "content": "Who is the best French painter? Answer in one short sentence.",
                 "role": "user",
             },
-        ], agent_id="<id>", stream=False)
+        ], agent_id="<id>")
 
         # Handle response
         print(res)
@@ -263,14 +298,15 @@ This example shows how to create embedding request.
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
 
-    res = mistral.embeddings.create(inputs=[
+    res = mistral.embeddings.create(model="mistral-embed", inputs=[
         "Embed this sentence.",
         "As well as this one.",
-    ], model="mistral-embed")
+    ])
 
     # Handle response
     print(res)
@@ -286,14 +322,15 @@ from mistralai import Mistral
 import os
 
 async def main():
+
     async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral:
 
-        res = await mistral.embeddings.create_async(inputs=[
+        res = await mistral.embeddings.create_async(model="mistral-embed", inputs=[
             "Embed this sentence.",
             "As well as this one.",
-        ], model="mistral-embed")
+        ])
 
         # Handle response
         print(res)
@@ -467,6 +504,10 @@ The documentation for the GCP SDK is available [here](https://github.com/mistral
 * [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
 
+### [ocr](https://github.com/mistralai/client-python/blob/master/docs/sdks/ocr/README.md)
+
+* [process](https://github.com/mistralai/client-python/blob/master/docs/sdks/ocr/README.md#process) - OCR
+
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -486,6 +527,7 @@ underlying connection when the context is exited.
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -495,7 +537,7 @@ with Mistral(
             "content": "Who is the best French painter? Answer in one short sentence.",
             "role": "user",
         },
-    ], stream=True)
+    ])
 
     with res as event_stream:
         for event in event_stream:
@@ -523,6 +565,7 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -549,6 +592,7 @@ from mistralai import Mistral
 from mistralai.utils import BackoffStrategy, RetryConfig
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -567,6 +611,7 @@ from mistralai import Mistral
 from mistralai.utils import BackoffStrategy, RetryConfig
 import os
 
+
 with Mistral(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key=os.getenv("MISTRAL_API_KEY", ""),
@@ -607,6 +652,7 @@ When custom error responses are specified for an operation, the SDK may also rai
 from mistralai import Mistral, models
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -634,9 +680,9 @@ with Mistral(
 
 You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
 
-| Name | Server                   |
-| ---- | ------------------------ |
-| `eu` | `https://api.mistral.ai` |
+| Name | Server                   | Description          |
+| ---- | ------------------------ | -------------------- |
+| `eu` | `https://api.mistral.ai` | EU Production server |
 
 #### Example
 
@@ -644,6 +690,7 @@ You can override the default server globally by passing a server name to the `se
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     server="eu",
     api_key=os.getenv("MISTRAL_API_KEY", ""),
@@ -663,6 +710,7 @@ The default server can also be overridden globally by passing a URL to the `serv
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     server_url="https://api.mistral.ai",
     api_key=os.getenv("MISTRAL_API_KEY", ""),
@@ -773,6 +821,7 @@ To authenticate with the API the `api_key` parameter must be set when initializi
 from mistralai import Mistral
 import os
 
+
 with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
@@ -796,6 +845,7 @@ The `Mistral` class implements the context manager protocol and registers a fina
 from mistralai import Mistral
 import os
 def main():
+
     with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral:
@@ -804,6 +854,7 @@ def main():
 
 # Or when using async:
 async def amain():
+
     async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     ) as mistral: