mistralai 1.0.0rc2__py3-none-any.whl → 1.0.2__py3-none-any.whl

mistralai/utils/forms.py

@@ -17,7 +17,7 @@ from .metadata import (
     MultipartFormMetadata,
     find_field_metadata,
 )
-from .values import _val_to_string
+from .values import _is_set, _val_to_string
 
 
 def _populate_form(
@@ -27,7 +27,7 @@ def _populate_form(
     delimiter: str,
     form: Dict[str, List[str]],
 ):
-    if obj is None:
+    if not _is_set(obj):
         return form
 
     if isinstance(obj, BaseModel):
@@ -41,7 +41,7 @@ def _populate_form(
                 continue
 
             val = getattr(obj, name)
-            if val is None:
+            if not _is_set(val):
                 continue
 
             if explode:
@@ -54,7 +54,7 @@ def _populate_form(
     elif isinstance(obj, Dict):
         items = []
         for key, value in obj.items():
-            if value is None:
+            if not _is_set(value):
                 continue
 
             if explode:
@@ -68,7 +68,7 @@ def _populate_form(
         items = []
 
         for value in obj:
-            if value is None:
+            if not _is_set(value):
                 continue
 
             if explode:
@@ -102,7 +102,7 @@ def serialize_multipart_form(
         field = request_fields[name]
 
         val = getattr(request, name)
-        if val is None:
+        if not _is_set(val):
             continue
 
         field_metadata = find_field_metadata(field, MultipartFormMetadata)
@@ -156,7 +156,7 @@ def serialize_multipart_form(
                 values = []
 
                 for value in val:
-                    if value is None:
+                    if not _is_set(value):
                         continue
                     values.append(_val_to_string(value))
 
@@ -176,7 +176,7 @@ def serialize_form_data(data: Any) -> Dict[str, Any]:
             field = data_fields[name]
 
             val = getattr(data, name)
-            if val is None:
+            if not _is_set(val):
                 continue
 
             metadata = find_field_metadata(field, FormMetadata)
@@ -200,7 +200,8 @@ def serialize_form_data(data: Any) -> Dict[str, Any]:
                     raise ValueError(f"Invalid form style for field {name}")
     elif isinstance(data, Dict):
         for key, value in data.items():
-            form[key] = [_val_to_string(value)]
+            if _is_set(value):
+                form[key] = [_val_to_string(value)]
     else:
         raise TypeError(f"Invalid request body type {type(data)} for form data")
 

mistralai/utils/headers.py

@@ -15,16 +15,16 @@ from .metadata import (
     find_field_metadata,
 )
 
-from .values import _populate_from_globals, _val_to_string
+from .values import _is_set, _populate_from_globals, _val_to_string
 
 
 def get_headers(headers_params: Any, gbls: Optional[Any] = None) -> Dict[str, str]:
     headers: Dict[str, str] = {}
 
     globals_already_populated = []
-    if headers_params is not None:
+    if _is_set(headers_params):
         globals_already_populated = _populate_headers(headers_params, gbls, headers, [])
-    if gbls is not None:
+    if _is_set(gbls):
         _populate_headers(gbls, None, headers, globals_already_populated)
 
     return headers
@@ -67,7 +67,7 @@ def _populate_headers(
 
 
 def _serialize_header(explode: bool, obj: Any) -> str:
-    if obj is None:
+    if not _is_set(obj):
         return ""
 
     if isinstance(obj, BaseModel):
@@ -83,7 +83,7 @@ def _serialize_header(explode: bool, obj: Any) -> str:
             f_name = obj_field.alias if obj_field.alias is not None else name
 
             val = getattr(obj, name)
-            if val is None:
+            if not _is_set(val):
                 continue
 
             if explode:
@@ -98,7 +98,7 @@ def _serialize_header(explode: bool, obj: Any) -> str:
         items = []
 
         for key, value in obj.items():
-            if value is None:
+            if not _is_set(value):
                 continue
 
             if explode:
@@ -113,14 +113,14 @@ def _serialize_header(explode: bool, obj: Any) -> str:
         items = []
 
         for value in obj:
-            if value is None:
+            if not _is_set(value):
                 continue
 
             items.append(_val_to_string(value))
 
         if len(items) > 0:
             return ",".join(items)
-    else:
+    elif _is_set(obj):
         return f"{_val_to_string(obj)}"
 
     return ""

mistralai/utils/logger.py

@@ -1,6 +1,8 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 import httpx
+import logging
+import os
 from typing import Any, Protocol
 
 class Logger(Protocol):
@@ -14,3 +16,9 @@ class NoOpLogger:
 def get_body_content(req: httpx.Request) -> str:
     return "<streaming body>" if not hasattr(req, "_content") else str(req.content)
 
+def get_default_logger() -> Logger:
+    if os.getenv("MISTRAL_DEBUG"):
+        logging.basicConfig(level=logging.DEBUG)
+        return logging.getLogger("mistralai")
+    return NoOpLogger()
+

mistralai/utils/queryparams.py

@@ -15,7 +15,12 @@ from .metadata import (
     QueryParamMetadata,
     find_field_metadata,
 )
-from .values import _get_serialized_params, _populate_from_globals, _val_to_string
+from .values import (
+    _get_serialized_params,
+    _is_set,
+    _populate_from_globals,
+    _val_to_string,
+)
 from .forms import _populate_form
 
 
@@ -26,7 +31,7 @@ def get_query_params(
     params: Dict[str, List[str]] = {}
 
     globals_already_populated = _populate_query_params(query_params, gbls, params, [])
-    if gbls is not None:
+    if _is_set(gbls):
         _populate_query_params(gbls, None, params, globals_already_populated)
 
     return params
@@ -55,7 +60,7 @@ def _populate_query_params(
         if not metadata:
             continue
 
-        value = getattr(query_params, name) if query_params is not None else None
+        value = getattr(query_params, name) if _is_set(query_params) else None
 
         value, global_found = _populate_from_globals(
             name, value, QueryParamMetadata, gbls
@@ -99,7 +104,7 @@ def _populate_deep_object_query_params(
     obj: Any,
     params: Dict[str, List[str]],
 ):
-    if obj is None:
+    if not _is_set(obj):
         return
 
     if isinstance(obj, BaseModel):
@@ -113,10 +118,7 @@ def _populate_deep_object_query_params_basemodel(
     obj: Any,
     params: Dict[str, List[str]],
 ):
-    if obj is None:
-        return
-
-    if not isinstance(obj, BaseModel):
+    if not _is_set(obj) or not isinstance(obj, BaseModel):
         return
 
     obj_fields: Dict[str, FieldInfo] = obj.__class__.model_fields
@@ -128,11 +130,11 @@ def _populate_deep_object_query_params_basemodel(
         params_key = f"{prior_params_key}[{f_name}]"
 
         obj_param_metadata = find_field_metadata(obj_field, QueryParamMetadata)
-        if obj_param_metadata is None:
+        if not _is_set(obj_param_metadata):
             continue
 
         obj_val = getattr(obj, name)
-        if obj_val is None:
+        if not _is_set(obj_val):
             continue
 
         if isinstance(obj_val, BaseModel):
@@ -150,11 +152,11 @@ def _populate_deep_object_query_params_dict(
     value: Dict,
     params: Dict[str, List[str]],
 ):
-    if value is None:
+    if not _is_set(value):
         return
 
     for key, val in value.items():
-        if val is None:
+        if not _is_set(val):
             continue
 
         params_key = f"{prior_params_key}[{key}]"
@@ -174,11 +176,11 @@ def _populate_deep_object_query_params_list(
     value: List,
     params: Dict[str, List[str]],
 ):
-    if value is None:
+    if not _is_set(value):
         return
 
     for val in value:
-        if val is None:
+        if not _is_set(val):
             continue
 
         if params.get(params_key) is None:

mistralai/utils/serializers.py

@@ -9,13 +9,15 @@ from pydantic import ConfigDict, create_model
 from pydantic_core import from_json
 from typing_inspect import is_optional_type
 
-from ..types.basemodel import BaseModel, Nullable, OptionalNullable
+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:
             return None
+        if isinstance(d, Unset):
+            return d
 
         if not isinstance(d, Decimal):
             raise ValueError("Expected Decimal object")
@@ -29,7 +31,7 @@ def validate_decimal(d):
     if d is None:
         return None
 
-    if isinstance(d, Decimal):
+    if isinstance(d, (Decimal, Unset)):
         return d
 
     if not isinstance(d, (str, int, float)):
@@ -42,6 +44,8 @@ def serialize_float(as_str: bool):
     def serialize(f):
         if is_optional_type(type(f)) and f is None:
             return None
+        if isinstance(f, Unset):
+            return f
 
         if not isinstance(f, float):
             raise ValueError("Expected float")
@@ -55,7 +59,7 @@ def validate_float(f):
     if f is None:
         return None
 
-    if isinstance(f, float):
+    if isinstance(f, (float, Unset)):
         return f
 
     if not isinstance(f, str):
@@ -65,14 +69,16 @@ def validate_float(f):
 
 
 def serialize_int(as_str: bool):
-    def serialize(b):
-        if is_optional_type(type(b)) and b is None:
+    def serialize(i):
+        if is_optional_type(type(i)) and i is None:
             return None
+        if isinstance(i, Unset):
+            return i
 
-        if not isinstance(b, int):
+        if not isinstance(i, int):
             raise ValueError("Expected int")
 
-        return str(b) if as_str else b
+        return str(i) if as_str else i
 
     return serialize
 
@@ -81,7 +87,7 @@ def validate_int(b):
     if b is None:
         return None
 
-    if isinstance(b, int):
+    if isinstance(b, (int, Unset)):
         return b
 
     if not isinstance(b, str):
@@ -95,6 +101,9 @@ def validate_open_enum(is_int: bool):
         if e is None:
             return None
 
+        if isinstance(e, Unset):
+            return e
+
         if is_int:
             if not isinstance(e, int):
                 raise ValueError("Expected int")

mistralai/utils/url.py

@@ -18,7 +18,12 @@ from .metadata import (
     PathParamMetadata,
     find_field_metadata,
 )
-from .values import _get_serialized_params, _populate_from_globals, _val_to_string
+from .values import (
+    _get_serialized_params,
+    _is_set,
+    _populate_from_globals,
+    _val_to_string,
+)
 
 
 def generate_url(
@@ -32,7 +37,7 @@ def generate_url(
     globals_already_populated = _populate_path_params(
         path_params, gbls, path_param_values, []
     )
-    if gbls is not None:
+    if _is_set(gbls):
         _populate_path_params(gbls, None, path_param_values, globals_already_populated)
 
     for key, value in path_param_values.items():
@@ -64,14 +69,14 @@ def _populate_path_params(
         if param_metadata is None:
             continue
 
-        param = getattr(path_params, name) if path_params is not None else None
+        param = getattr(path_params, name) if _is_set(path_params) else None
         param, global_found = _populate_from_globals(
             name, param, PathParamMetadata, gbls
         )
         if global_found:
             globals_already_populated.append(name)
 
-        if param is None:
+        if not _is_set(param):
             continue
 
         f_name = field.alias if field.alias is not None else name
@@ -87,13 +92,13 @@ def _populate_path_params(
             if param_metadata.style == "simple":
                 if isinstance(param, List):
                     for pp_val in param:
-                        if pp_val is None:
+                        if not _is_set(pp_val):
                             continue
                         pp_vals.append(_val_to_string(pp_val))
                     path_param_values[f_name] = ",".join(pp_vals)
                 elif isinstance(param, Dict):
                     for pp_key in param:
-                        if param[pp_key] is None:
+                        if not _is_set(param[pp_key]):
                             continue
                         if param_metadata.explode:
                             pp_vals.append(f"{pp_key}={_val_to_string(param[pp_key])}")
@@ -116,7 +121,7 @@ def _populate_path_params(
                         )
 
                         param_field_val = getattr(param, name)
-                        if param_field_val is None:
+                        if not _is_set(param_field_val):
                             continue
                         if param_metadata.explode:
                             pp_vals.append(
@@ -127,7 +132,7 @@ def _populate_path_params(
                                 f"{param_name},{_val_to_string(param_field_val)}"
                             )
                     path_param_values[f_name] = ",".join(pp_vals)
-                else:
+                elif _is_set(param):
                     path_param_values[f_name] = _val_to_string(param)
 
     return globals_already_populated

mistralai/utils/values.py

@@ -10,6 +10,8 @@ from httpx import Response
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
 
+from ..types.basemodel import Unset
+
 from .serializers import marshal_json
 
 from .metadata import ParamMetadata, find_field_metadata
@@ -126,3 +128,7 @@ def _get_serialized_params(
         params[field_name] = marshal_json(obj, typ)
 
     return params
+
+
+def _is_set(value: Any) -> bool:
+    return value is not None and not isinstance(value, Unset)

mistralai/version.py

@@ -0,0 +1,7 @@
+from importlib import metadata
+
+try:
+    __version__ = metadata.version(__package__)
+except metadata.PackageNotFoundError:
+    # Case where package metadata is not available.
+    __version__ = ""

{mistralai-1.0.0rc2.dist-info → mistralai-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mistralai
-Version: 1.0.0rc2
+Version: 1.0.2
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
 Requires-Python: >=3.8,<4.0
@@ -20,15 +20,26 @@ Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "gcp"
 Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
 Description-Content-Type: text/markdown
 
-# mistralai
-
-<div align="left">
-    <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
-</div>
+# Mistral Python Client
 
 ## Migration warning
  
-This documentation is for Mistralai 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](MIGRATION.md)
+
+## API Key Setup
+
+Before you begin, you will need a Mistral AI API key.
+
+1. Get your own Mistral API Key: <https://docs.mistral.ai/#api-access>
+2. Set your Mistral API Key as an environment variable. You only need to do this once.
+
+```bash
+# set Mistral API Key (using zsh for example)
+$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv
+
+# reload the environment (or just quit and open a new terminal)
+$ source ~/.zshenv
+```
 
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
@@ -200,6 +211,12 @@ asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+
+### More examples
+
+You can run the examples in the `examples/` directory using `poetry run` or by entering the virtual environment using `poetry shell`.
+
+
 ## Providers' SDKs Example Usage
 
 ### Azure AI
@@ -329,7 +346,7 @@ The documentation for the GCP SDK is available [here](packages/mistralai_gcp/REA
 
 ### [agents](docs/sdks/agents/README.md)
 
-* [complete](docs/sdks/agents/README.md#complete) - Chat Completion
+* [complete](docs/sdks/agents/README.md#complete) - Agents Completion
 * [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion
 
 ### [embeddings](docs/sdks/embeddings/README.md)
@@ -634,7 +651,7 @@ This SDK supports the following security scheme globally:
 | -------------------- | -------------------- | -------------------- | -------------------- |
 | `api_key`            | http                 | HTTP Bearer          | `MISTRAL_API_KEY`    |
 
-To authenticate with the API the `null` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
 ```python
 from mistralai import Mistral
 import os
@@ -656,8 +673,9 @@ if res is not None:
 <!-- Start Debugging [debug] -->
 ## Debugging
 
-To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
+You can setup your SDK to emit debug logs for SDK requests and responses.
 
+You can pass your own logger class directly into your SDK.
 ```python
 from mistralai import Mistral
 import logging
@@ -665,22 +683,26 @@ import logging
 logging.basicConfig(level=logging.DEBUG)
 s = Mistral(debug_logger=logging.getLogger("mistralai"))
 ```
+
+You can also enable a default debug logger by setting an environment variable `MISTRAL_DEBUG` to true.
 <!-- End Debugging [debug] -->
 
-<!-- Placeholder for Future Speakeasy SDK Sections -->
+<!-- Start IDE Support [idesupport] -->
+## IDE Support
 
-# Development
+### PyCharm
 
-## Maturity
+Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
 
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
-to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
-looking for the latest version.
+- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
+<!-- End IDE Support [idesupport] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
 
 ## Contributions
 
 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. 
 
-### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
-