mistralai 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

mistralai/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "mistralai"
-__version__: str = "1.4.0"
+__version__: str = "1.5.0"
 __openapi_doc_version__: str = "0.0.2"
-__gen_version__: str = "2.493.32"
-__user_agent__: str = "speakeasy-sdk/python 1.4.0 2.493.32 0.0.2 mistralai"
+__gen_version__: str = "2.497.0"
+__user_agent__: str = "speakeasy-sdk/python 1.5.0 2.497.0 0.0.2 mistralai"
 
 try:
     if __package__ is not None:

mistralai/chat.py

@@ -7,10 +7,92 @@ from mistralai.types import Nullable, OptionalNullable, UNSET
 from mistralai.utils import eventstreaming, get_security_from_env
 from typing import Any, List, Mapping, Optional, Union
 
+# region imports
+from typing import Type
+from mistralai.extra import (
+    convert_to_parsed_chat_completion_response,
+    response_format_from_pydantic_model,
+    CustomPydanticModel,
+    ParsedChatCompletionResponse,
+)
+# endregion imports
+
 
 class Chat(BaseSDK):
     r"""Chat Completion API."""
 
+    # region sdk-class-body
+    # Custom .parse methods for the Structure Outputs Feature.
+
+    def parse(
+        self, response_format: Type[CustomPydanticModel], **kwargs: Any
+    ) -> ParsedChatCompletionResponse[CustomPydanticModel]:
+        """
+        Parse the response using the provided response format.
+        :param Type[CustomPydanticModel] response_format: The Pydantic model to parse the response into
+        :param Any **kwargs Additional keyword arguments to pass to the .complete method
+        :return: The parsed response
+        """
+        # Convert the input Pydantic Model to a strict JSON ready to be passed to chat.complete
+        json_response_format = response_format_from_pydantic_model(response_format)
+        # Run the inference
+        response = self.complete(**kwargs, response_format=json_response_format)
+        # Parse response back to the input pydantic model
+        parsed_response = convert_to_parsed_chat_completion_response(
+            response, response_format
+        )
+        return parsed_response
+
+    async def parse_async(
+        self, response_format: Type[CustomPydanticModel], **kwargs
+    ) -> ParsedChatCompletionResponse[CustomPydanticModel]:
+        """
+        Asynchronously parse the response using the provided response format.
+        :param Type[CustomPydanticModel] response_format: The Pydantic model to parse the response into
+        :param Any **kwargs Additional keyword arguments to pass to the .complete method
+        :return: The parsed response
+        """
+        json_response_format = response_format_from_pydantic_model(response_format)
+        response = await self.complete_async(  # pylint: disable=E1125
+            **kwargs, response_format=json_response_format
+        )
+        parsed_response = convert_to_parsed_chat_completion_response(
+            response, response_format
+        )
+        return parsed_response
+
+    def parse_stream(
+        self, response_format: Type[CustomPydanticModel], **kwargs
+    ) -> eventstreaming.EventStream[models.CompletionEvent]:
+        """
+        Parse the response using the provided response format.
+        For now the response will be in JSON format not in the input Pydantic model.
+        :param Type[CustomPydanticModel] response_format: The Pydantic model to parse the response into
+        :param Any **kwargs Additional keyword arguments to pass to the .stream method
+        :return: The JSON parsed response
+        """
+        json_response_format = response_format_from_pydantic_model(response_format)
+        response = self.stream(**kwargs, response_format=json_response_format)
+        return response
+
+    async def parse_stream_async(
+        self, response_format: Type[CustomPydanticModel], **kwargs
+    ) -> eventstreaming.EventStreamAsync[models.CompletionEvent]:
+        """
+        Asynchronously parse the response using the provided response format.
+        For now the response will be in JSON format not in the input Pydantic model.
+        :param Type[CustomPydanticModel] response_format: The Pydantic model to parse the response into
+        :param Any **kwargs Additional keyword arguments to pass to the .stream method
+        :return: The JSON parsed response
+        """
+        json_response_format = response_format_from_pydantic_model(response_format)
+        response = await self.stream_async(  # pylint: disable=E1125
+            **kwargs, response_format=json_response_format
+        )
+        return response
+
+    # endregion sdk-class-body
+
     def complete(
         self,
         *,

mistralai/extra/README.md

@@ -0,0 +1,56 @@
+## Context
+
+The extra package contains the custom logic which is too complex to be generated by Speakeasy from the OpenAPI specs. It was introduced to add the Structured Outputs feature.
+
+## Development / Contributing
+
+To add custom code in the SDK, you need to use [Speakeasy custom code regions](https://www.speakeasy.com/docs/customize/code/code-regions/overview) as below.
+
+### Runbook of SDK customization
+
+1. Add the code you want to import in the `src/mistralai/extra/` package. To have it importable from the SDK, you need to add it in the `__init__.py` file:
+```python
+from .my_custom_file import my_custom_function
+
+__all__ = ["my_custom_function"]
+```
+
+2. Add a new custom code region in the SDK files, e.g in `src/mistralai/chat.py`:
+```python
+# region imports
+from typing import Type
+from mistralai.extra import my_custom_function
+# endregion imports
+
+class Chat(BaseSDK):
+    r"""Chat Completion API."""
+
+    # region sdk-class-body
+    def my_custom_method(self, param: str) -> Type[some_type]:
+        output = my_custom_function(param1)
+        return output
+    # endregion sdk-class-body
+```
+
+3. Now build the SDK with the custom code:
+```bash
+rm -rf dist; poetry build; python3 -m pip install ~/client-python/dist/mistralai-1.4.1-py3-none-any.whl --force-reinstall
+```
+
+4. And now you should be able to call the custom method:
+```python
+import os
+from mistralai import Mistral
+
+api_key = os.environ["MISTRAL_API_KEY"]
+client = Mistral(api_key=api_key)
+
+client.chat.my_custom_method(param="test")
+```
+
+### Run the unit tests
+
+To run the unit tests for the `extra` package, you can run the following command from the root of the repository:
+```bash
+python3.12 -m unittest discover -s src/mistralai/extra/tests -t src
+```

mistralai/extra/__init__.py

@@ -0,0 +1,5 @@
+from .struct_chat import ParsedChatCompletionResponse, convert_to_parsed_chat_completion_response
+from .utils import response_format_from_pydantic_model
+from .utils.response_format import CustomPydanticModel
+
+__all__ = ["convert_to_parsed_chat_completion_response", "response_format_from_pydantic_model", "CustomPydanticModel", "ParsedChatCompletionResponse"]

mistralai/extra/struct_chat.py

@@ -0,0 +1,41 @@
+from ..models import ChatCompletionResponse, ChatCompletionChoice, AssistantMessage
+from .utils.response_format import  CustomPydanticModel, pydantic_model_from_json
+from typing import List, Optional, Type, Generic
+from pydantic import BaseModel
+import json
+
+class ParsedAssistantMessage(AssistantMessage, Generic[CustomPydanticModel]):
+    parsed: Optional[CustomPydanticModel]
+
+class ParsedChatCompletionChoice(ChatCompletionChoice, Generic[CustomPydanticModel]):
+    message: Optional[ParsedAssistantMessage[CustomPydanticModel]]  # type: ignore
+
+class ParsedChatCompletionResponse(ChatCompletionResponse, Generic[CustomPydanticModel]):
+    choices: Optional[List[ParsedChatCompletionChoice[CustomPydanticModel]]] # type: ignore
+
+def convert_to_parsed_chat_completion_response(response: ChatCompletionResponse, response_format: Type[BaseModel]) -> ParsedChatCompletionResponse:
+    parsed_choices = []
+
+    if response.choices:
+        for choice in response.choices:
+            if choice.message:
+                parsed_message: ParsedAssistantMessage = ParsedAssistantMessage(
+                    **choice.message.model_dump(),
+                    parsed=None
+                )
+                if isinstance(parsed_message.content, str):
+                    parsed_message.parsed = pydantic_model_from_json(json.loads(parsed_message.content), response_format)
+                elif parsed_message.content is None:
+                    parsed_message.parsed = None
+                else:
+                    raise TypeError(f"Unexpected type for message.content: {type(parsed_message.content)}")
+                choice_dict = choice.model_dump()
+                choice_dict["message"] = parsed_message
+                parsed_choice: ParsedChatCompletionChoice = ParsedChatCompletionChoice(**choice_dict)
+                parsed_choices.append(parsed_choice)
+            else:
+                parsed_choice = ParsedChatCompletionChoice(**choice.model_dump())
+                parsed_choices.append(parsed_choice)
+    response_dict = response.model_dump()
+    response_dict["choices"] = parsed_choices
+    return ParsedChatCompletionResponse(**response_dict)

mistralai/extra/tests/test_struct_chat.py

@@ -0,0 +1,103 @@
+import unittest
+from ..struct_chat import (
+    convert_to_parsed_chat_completion_response,
+    ParsedChatCompletionResponse,
+    ParsedChatCompletionChoice,
+    ParsedAssistantMessage,
+)
+from ...models import (
+    ChatCompletionResponse,
+    UsageInfo,
+    ChatCompletionChoice,
+    AssistantMessage,
+)
+from pydantic import BaseModel
+
+
+class Explanation(BaseModel):
+    explanation: str
+    output: str
+
+
+class MathDemonstration(BaseModel):
+    steps: list[Explanation]
+    final_answer: str
+
+
+mock_cc_response = ChatCompletionResponse(
+    id="c0271b2098954c6094231703875ca0bc",
+    object="chat.completion",
+    model="mistral-large-latest",
+    usage=UsageInfo(prompt_tokens=75, completion_tokens=220, total_tokens=295),
+    created=1737727558,
+    choices=[
+        ChatCompletionChoice(
+            index=0,
+            message=AssistantMessage(
+                content='{\n  "final_answer": "x = -4",\n  "steps": [\n    {\n      "explanation": "Start with the given equation.",\n      "output": "8x + 7 = -23"\n    },\n    {\n      "explanation": "Subtract 7 from both sides to isolate the term with x.",\n      "output": "8x = -23 - 7"\n    },\n    {\n      "explanation": "Simplify the right side of the equation.",\n      "output": "8x = -30"\n    },\n    {\n      "explanation": "Divide both sides by 8 to solve for x.",\n      "output": "x = -30 / 8"\n    },\n    {\n      "explanation": "Simplify the fraction to get the final answer.",\n      "output": "x = -4"\n    }\n  ]\n}',
+                tool_calls=None,
+                prefix=False,
+                role="assistant",
+            ),
+            finish_reason="stop",
+        )
+    ],
+)
+
+
+expected_response = ParsedChatCompletionResponse(
+    choices=[
+        ParsedChatCompletionChoice(
+            index=0,
+            message=ParsedAssistantMessage(
+                content='{\n  "final_answer": "x = -4",\n  "steps": [\n    {\n      "explanation": "Start with the given equation.",\n      "output": "8x + 7 = -23"\n    },\n    {\n      "explanation": "Subtract 7 from both sides to isolate the term with x.",\n      "output": "8x = -23 - 7"\n    },\n    {\n      "explanation": "Simplify the right side of the equation.",\n      "output": "8x = -30"\n    },\n    {\n      "explanation": "Divide both sides by 8 to solve for x.",\n      "output": "x = -30 / 8"\n    },\n    {\n      "explanation": "Simplify the fraction to get the final answer.",\n      "output": "x = -4"\n    }\n  ]\n}',
+                tool_calls=None,
+                prefix=False,
+                role="assistant",
+                parsed=MathDemonstration(
+                    steps=[
+                        Explanation(
+                            explanation="Start with the given equation.",
+                            output="8x + 7 = -23",
+                        ),
+                        Explanation(
+                            explanation="Subtract 7 from both sides to isolate the term with x.",
+                            output="8x = -23 - 7",
+                        ),
+                        Explanation(
+                            explanation="Simplify the right side of the equation.",
+                            output="8x = -30",
+                        ),
+                        Explanation(
+                            explanation="Divide both sides by 8 to solve for x.",
+                            output="x = -30 / 8",
+                        ),
+                        Explanation(
+                            explanation="Simplify the fraction to get the final answer.",
+                            output="x = -4",
+                        ),
+                    ],
+                    final_answer="x = -4",
+                ),
+            ),
+            finish_reason="stop",
+        )
+    ],
+    created=1737727558,
+    id="c0271b2098954c6094231703875ca0bc",
+    model="mistral-large-latest",
+    object="chat.completion",
+    usage=UsageInfo(prompt_tokens=75, completion_tokens=220, total_tokens=295),
+)
+
+
+class TestConvertToParsedChatCompletionResponse(unittest.TestCase):
+    def test_convert_to_parsed_chat_completion_response(self):
+        output = convert_to_parsed_chat_completion_response(
+            mock_cc_response, MathDemonstration
+        )
+        self.assertEqual(output, expected_response)
+
+
+if __name__ == "__main__":
+    unittest.main()

mistralai/extra/tests/test_utils.py

@@ -0,0 +1,162 @@
+from ..utils.response_format import (
+    pydantic_model_from_json,
+    response_format_from_pydantic_model,
+    rec_strict_json_schema,
+)
+from pydantic import BaseModel, ValidationError
+
+from ...models import ResponseFormat, JSONSchema
+from ...types.basemodel import Unset
+
+import unittest
+
+
+class Student(BaseModel):
+    name: str
+    age: int
+
+
+class Explanation(BaseModel):
+    explanation: str
+    output: str
+
+
+class MathDemonstration(BaseModel):
+    steps: list[Explanation]
+    final_answer: str
+
+
+mathdemo_schema = {
+    "$defs": {
+        "Explanation": {
+            "properties": {
+                "explanation": {"title": "Explanation", "type": "string"},
+                "output": {"title": "Output", "type": "string"},
+            },
+            "required": ["explanation", "output"],
+            "title": "Explanation",
+            "type": "object",
+        }
+    },
+    "properties": {
+        "steps": {
+            "items": {"$ref": "#/$defs/Explanation"},
+            "title": "Steps",
+            "type": "array",
+        },
+        "final_answer": {"title": "Final Answer", "type": "string"},
+    },
+    "required": ["steps", "final_answer"],
+    "title": "MathDemonstration",
+    "type": "object",
+}
+
+mathdemo_strict_schema = mathdemo_schema.copy()
+mathdemo_strict_schema["$defs"]["Explanation"]["additionalProperties"] = False # type: ignore
+mathdemo_strict_schema["additionalProperties"] = False
+
+mathdemo_response_format = ResponseFormat(
+    type="json_schema",
+    json_schema=JSONSchema(
+        name="MathDemonstration",
+        schema_definition=mathdemo_strict_schema,
+        description=Unset(),
+        strict=True,
+    ),
+)
+
+
+class TestResponseFormat(unittest.TestCase):
+    def test_pydantic_model_from_json(self):
+        missing_json_data = {"name": "Jean Dupont"}
+        good_json_data = {"name": "Jean Dupont", "age": 25}
+        extra_json_data = {
+            "name": "Jean Dupont",
+            "age": 25,
+            "extra_field": "extra_value",
+        }
+        complex_json_data = {
+            "final_answer": "x = -4",
+            "steps": [
+                {
+                    "explanation": "Start with the given equation.",
+                    "output": "8x + 7 = -23",
+                },
+                {
+                    "explanation": "Subtract 7 from both sides to isolate the term with x.",
+                    "output": "8x = -23 - 7",
+                },
+                {
+                    "explanation": "Simplify the right side of the equation.",
+                    "output": "8x = -30",
+                },
+                {
+                    "explanation": "Divide both sides by 8 to solve for x.",
+                    "output": "x = -30 / 8",
+                },
+                {
+                    "explanation": "Simplify the fraction to get the final answer.",
+                    "output": "x = -4",
+                },
+            ],
+        }
+
+        self.assertEqual(
+            pydantic_model_from_json(good_json_data, Student),
+            Student(name="Jean Dupont", age=25),
+        )
+        self.assertEqual(
+            pydantic_model_from_json(extra_json_data, Student),
+            Student(name="Jean Dupont", age=25),
+        )
+        self.assertEqual(
+            pydantic_model_from_json(complex_json_data, MathDemonstration),
+            MathDemonstration(
+                steps=[
+                    Explanation(
+                        explanation="Start with the given equation.",
+                        output="8x + 7 = -23",
+                    ),
+                    Explanation(
+                        explanation="Subtract 7 from both sides to isolate the term with x.",
+                        output="8x = -23 - 7",
+                    ),
+                    Explanation(
+                        explanation="Simplify the right side of the equation.",
+                        output="8x = -30",
+                    ),
+                    Explanation(
+                        explanation="Divide both sides by 8 to solve for x.",
+                        output="x = -30 / 8",
+                    ),
+                    Explanation(
+                        explanation="Simplify the fraction to get the final answer.",
+                        output="x = -4",
+                    ),
+                ],
+                final_answer="x = -4",
+            ),
+        )
+
+        # Check it raises a validation error
+        with self.assertRaises(ValidationError):
+            pydantic_model_from_json(missing_json_data, Student)  # type: ignore
+
+    def test_response_format_from_pydantic_model(self):
+        self.assertEqual(
+            response_format_from_pydantic_model(MathDemonstration),
+            mathdemo_response_format,
+        )
+
+    def test_rec_strict_json_schema(self):
+        invalid_schema = mathdemo_schema | {"wrong_value": 1}
+        self.assertEqual(
+            rec_strict_json_schema(mathdemo_schema), mathdemo_strict_schema
+        )
+
+        with self.assertRaises(ValueError):
+            rec_strict_json_schema(invalid_schema)
+
+
+if __name__ == "__main__":
+    unittest.main()

mistralai/extra/utils/__init__.py

@@ -0,0 +1,3 @@
+from .response_format import response_format_from_pydantic_model
+
+__all__ = ["response_format_from_pydantic_model"]

mistralai/extra/utils/_pydantic_helper.py

@@ -0,0 +1,20 @@
+from typing import Any
+
+def rec_strict_json_schema(schema_node: Any) -> Any:
+    """
+    Recursively set the additionalProperties property to False for all objects in the JSON Schema.
+    This makes the JSON Schema strict (i.e. no additional properties are allowed).
+    """
+    if isinstance(schema_node, (str, bool)):
+        return schema_node
+    if isinstance(schema_node, dict):
+        if "type" in schema_node and schema_node["type"] == "object":
+            schema_node["additionalProperties"] = False
+        for key, value in schema_node.items():
+            schema_node[key] = rec_strict_json_schema(value)
+    elif isinstance(schema_node, list):
+        for i, value in enumerate(schema_node):
+            schema_node[i] = rec_strict_json_schema(value)
+    else:
+        raise ValueError(f"Unexpected type: {schema_node}")
+    return schema_node

mistralai/extra/utils/response_format.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel
+from typing import TypeVar, Any, Type
+from ...models import JSONSchema, ResponseFormat
+from ._pydantic_helper import rec_strict_json_schema
+
+CustomPydanticModel = TypeVar("CustomPydanticModel", bound=BaseModel)
+
+
+def response_format_from_pydantic_model(
+    model: type[CustomPydanticModel],
+) -> ResponseFormat:
+    """Generate a strict JSON schema from a pydantic model."""
+    model_schema = rec_strict_json_schema(model.model_json_schema())
+    json_schema = JSONSchema.model_validate(
+        {"name": model.__name__, "schema": model_schema, "strict": True}
+    )
+    return ResponseFormat(type="json_schema", json_schema=json_schema)
+
+
+def pydantic_model_from_json(
+    json_data: dict[str, Any], pydantic_model: Type[CustomPydanticModel]
+) -> CustomPydanticModel:
+    """Parse a JSON schema into a pydantic model."""
+    return pydantic_model.model_validate(json_data)

mistralai/httpclient.py

@@ -1,6 +1,8 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 # pyright: reportReturnType = false
+import asyncio
+from concurrent.futures import ThreadPoolExecutor
 from typing_extensions import Protocol, runtime_checkable
 import httpx
 from typing import Any, Optional, Union
@@ -82,3 +84,51 @@ class AsyncHttpClient(Protocol):
 
     async def aclose(self) -> None:
         pass
+
+
+class ClientOwner(Protocol):
+    client: Union[HttpClient, None]
+    async_client: Union[AsyncHttpClient, None]
+
+
+def close_clients(
+    owner: ClientOwner,
+    sync_client: Union[HttpClient, None],
+    async_client: Union[AsyncHttpClient, None],
+) -> None:
+    """
+    A finalizer function that is meant to be used with weakref.finalize to close
+    httpx clients used by an SDK so that underlying resources can be garbage
+    collected.
+    """
+
+    # Unset the client/async_client properties so there are no more references
+    # to them from the owning SDK instance and they can be reaped.
+    owner.client = None
+    owner.async_client = None
+
+    if sync_client is not None:
+        try:
+            sync_client.close()
+        except Exception:
+            pass
+
+    if async_client is not None:
+        is_async = False
+        try:
+            asyncio.get_running_loop()
+            is_async = True
+        except RuntimeError:
+            pass
+
+        try:
+            # If this function is called in an async loop then start another
+            # loop in a separate thread to close the async http client.
+            if is_async:
+                with ThreadPoolExecutor(max_workers=1) as executor:
+                    future = executor.submit(asyncio.run, async_client.aclose())
+                    future.result()
+            else:
+                asyncio.run(async_client.aclose())
+        except Exception:
+            pass

mistralai/models/__init__.py

@@ -264,6 +264,7 @@ from .jobs_api_routes_fine_tuning_update_fine_tuned_modelop import (
     JobsAPIRoutesFineTuningUpdateFineTunedModelRequestTypedDict,
 )
 from .jobsout import JobsOut, JobsOutObject, JobsOutTypedDict
+from .jsonschema import JSONSchema, JSONSchemaTypedDict
 from .legacyjobmetadataout import (
     LegacyJobMetadataOut,
     LegacyJobMetadataOutObject,
@@ -515,6 +516,8 @@ __all__ = [
     "InputsTypedDict",
     "Integrations",
     "IntegrationsTypedDict",
+    "JSONSchema",
+    "JSONSchemaTypedDict",
     "JobIn",
     "JobInIntegrations",
     "JobInIntegrationsTypedDict",

mistralai/models/jsonschema.py

@@ -0,0 +1,55 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Any, Dict, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class JSONSchemaTypedDict(TypedDict):
+    name: str
+    schema_definition: Dict[str, Any]
+    description: NotRequired[Nullable[str]]
+    strict: NotRequired[bool]
+
+
+class JSONSchema(BaseModel):
+    name: str
+
+    schema_definition: Annotated[Dict[str, Any], pydantic.Field(alias="schema")]
+
+    description: OptionalNullable[str] = UNSET
+
+    strict: Optional[bool] = False
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "strict"]
+        nullable_fields = ["description"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mistralai/models/responseformat.py

@@ -1,8 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .jsonschema import JSONSchema, JSONSchemaTypedDict
 from .responseformats import ResponseFormats
-from mistralai.types import BaseModel
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
 from typing import Optional
 from typing_extensions import NotRequired, TypedDict
 
@@ -10,8 +12,41 @@ from typing_extensions import NotRequired, TypedDict
 class ResponseFormatTypedDict(TypedDict):
     type: NotRequired[ResponseFormats]
     r"""An object specifying the format that the model must output. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message."""
+    json_schema: NotRequired[Nullable[JSONSchemaTypedDict]]
 
 
 class ResponseFormat(BaseModel):
     type: Optional[ResponseFormats] = None
     r"""An object specifying the format that the model must output. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message."""
+
+    json_schema: OptionalNullable[JSONSchema] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "json_schema"]
+        nullable_fields = ["json_schema"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

mistralai/models/responseformats.py

@@ -4,5 +4,5 @@ from __future__ import annotations
 from typing import Literal
 
 
-ResponseFormats = Literal["text", "json_object"]
+ResponseFormats = Literal["text", "json_object", "json_schema"]
 r"""An object specifying the format that the model must output. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message."""

mistralai/sdk.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from .httpclient import AsyncHttpClient, HttpClient
+from .httpclient import AsyncHttpClient, ClientOwner, HttpClient, close_clients
 from .sdkconfiguration import SDKConfiguration
 from .utils.logger import Logger, get_default_logger
 from .utils.retries import RetryConfig
@@ -18,7 +18,8 @@ from mistralai.fim import Fim
 from mistralai.fine_tuning import FineTuning
 from mistralai.models_ import Models
 from mistralai.types import OptionalNullable, UNSET
-from typing import Any, Callable, Dict, Optional, Union
+from typing import Any, Callable, Dict, Optional, Union, cast
+import weakref
 
 
 class Mistral(BaseSDK):
@@ -118,6 +119,14 @@ class Mistral(BaseSDK):
         # pylint: disable=protected-access
         self.sdk_configuration.__dict__["_hooks"] = hooks
 
+        weakref.finalize(
+            self,
+            close_clients,
+            cast(ClientOwner, self.sdk_configuration),
+            self.sdk_configuration.client,
+            self.sdk_configuration.async_client,
+        )
+
         self._init_sdks()
 
     def _init_sdks(self):

{mistralai-1.4.0.dist-info → mistralai-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mistralai
-Version: 1.4.0
+Version: 1.5.0
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
 Requires-Python: >=3.8
@@ -67,6 +67,7 @@ Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create yo
   * [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)
+  * [Resource Management](https://github.com/mistralai/client-python/blob/master/#resource-management)
   * [Debugging](https://github.com/mistralai/client-python/blob/master/#debugging)
   * [IDE Support](https://github.com/mistralai/client-python/blob/master/#ide-support)
 * [Development](https://github.com/mistralai/client-python/blob/master/#development)
@@ -77,6 +78,11 @@ Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create yo
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+> [!NOTE]
+> **Python version upgrade policy**
+>
+> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
+
 The SDK can be installed with either *pip* or *poetry* package managers.
 
 ### PIP
@@ -779,6 +785,32 @@ with Mistral(
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `Mistral` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from mistralai import Mistral
+import os
+def main():
+    with Mistral(
+        api_key=os.getenv("MISTRAL_API_KEY", ""),
+    ) as mistral:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+    async with Mistral(
+        api_key=os.getenv("MISTRAL_API_KEY", ""),
+    ) as mistral:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging
 

{mistralai-1.4.0.dist-info → mistralai-1.5.0.dist-info}/RECORD

@@ -131,22 +131,31 @@ mistralai/_hooks/deprecation_warning.py,sha256=eyEOf7-o9uqqNWJnufD2RXp3dYrGV4in9
 mistralai/_hooks/registration.py,sha256=ML0W-XbE4WYdJ4eGks_XxF2aLCJTaIWjQATFGzFwvyU,861
 mistralai/_hooks/sdkhooks.py,sha256=s-orhdvnV89TmI3QiPC2LWQtYeM9RrsG1CTll-fYZmQ,2559
 mistralai/_hooks/types.py,sha256=vUkTVk_TSaK10aEj368KYWvnd4T5EsawixMcTro_UHc,2570
-mistralai/_version.py,sha256=Ks6KHk739TqW4iKtkhh7FmwsiwVVsnyyC6K3ETq80ls,462
+mistralai/_version.py,sha256=GRgL4RQk2kYt7mohgi1PRAMqEbZSHKMkxC4qZQ_m4Ak,460
 mistralai/agents.py,sha256=63-FJfMJ_9Qb0O0-uorAJM8km4FHpCEjjIk14margM8,31392
 mistralai/async_client.py,sha256=KUdYxIIqoD6L7vB0EGwUR6lQ0NK5iCTHjnLVR9CVcJY,355
 mistralai/basesdk.py,sha256=da0sFeLR-ztU5-fuGJ4TMqUnnqSzXbPAjpNgKI52tBk,11999
 mistralai/batch.py,sha256=YN4D0Duwrap9Ysmp_lRpADYp1Znay7THE_z8ERGvDds,501
-mistralai/chat.py,sha256=wO3VoQYzEbBDly8sNKj1NKxlNMz51LN4E5toul-UKUs,35575
+mistralai/chat.py,sha256=n_FpKg-yN0CbAcnVRAkkwcXQuBPwiZBe3e1YSg2hfq8,39339
 mistralai/classifiers.py,sha256=oxGQEj6QfIWvV2GIAhfev9DVbFTG79uR5ODKTmOiJxs,16594
 mistralai/client.py,sha256=hrPg-LciKMKiascF0WbRRmqQyCv1lb2yDh6j-aaKVNo,509
 mistralai/embeddings.py,sha256=oT6SgsC3ODtn9mAWfpHN9Eli6puLmz9dEe-ZrY0QiPA,8590
+mistralai/extra/README.md,sha256=BTS9fy0ijkiUP7ZVoFQ7FVBxHtXIXqucYZyy_ucFjo4,1739
+mistralai/extra/__init__.py,sha256=MHf0pUgLc9Sb7eTUE31JlE2FKMxfQupmJ_iR8UkgQ9w,360
+mistralai/extra/struct_chat.py,sha256=ZkpdExC5rgC-nBZ44hQIVhQmK6lYMk36RBSFPZMFaIg,2157
+mistralai/extra/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mistralai/extra/tests/test_struct_chat.py,sha256=WT6GGfcbXCok8UkEny19u4q1g2QOgkekvmAb3ZinQZ8,4343
+mistralai/extra/tests/test_utils.py,sha256=VesGDR_IiE6u0iY7yOi1iERd7esdJgi2aL4xZp0vKVI,5113
+mistralai/extra/utils/__init__.py,sha256=SExo5t_hx0ybiQhVJIG3r3hOA-Pfny3lIO_WsqNXlN8,116
+mistralai/extra/utils/_pydantic_helper.py,sha256=kU_HbsSl1qGXnrrHnBcxun2MtHowu8eBp3jYMyFsPWw,859
+mistralai/extra/utils/response_format.py,sha256=OiIpNXMODKJ6U2QDCXxPHBoVtXzXF7jtBzCLmI4t_CU,907
 mistralai/files.py,sha256=E1-MxJc-84IdKrc-0k-bvYNa7OSoNFCQ7wBX9tMnFb8,44359
 mistralai/fim.py,sha256=WFlELwTAT_dT7HcBRuby8xqoQsUsw-IXqzqufyyqz_g,27289
 mistralai/fine_tuning.py,sha256=UENQqfE054VEsAYxdruV-TBLFIFfO-joXNznH08GUvE,477
-mistralai/httpclient.py,sha256=WDbLpMzo7qmWki_ryOJcCAYNI1T4uyWKV08rRuCdNII,2688
+mistralai/httpclient.py,sha256=N-D-srtDBykpfyVKacTY4upDGvNLqdWlEYqhJvta99E,4194
 mistralai/jobs.py,sha256=SVNlvn8XGaCkNJ5tKOKci5QLavacmkNqoYeIGF4ik0Q,43481
 mistralai/mistral_jobs.py,sha256=2ScKd2Tv79-MWxEQkrqr53Ikya8rmTbSiJ96judp7DY,30166
-mistralai/models/__init__.py,sha256=W9QnG5egzQoSpFCy5Oiz9wYHvbmN1EkVvwW173XeLsY,21852
+mistralai/models/__init__.py,sha256=IGlVf2t6ZzB5HvRNQpFaf5WmKJOemcrCU9Uvsf9IAz0,21953
 mistralai/models/agentscompletionrequest.py,sha256=2tV6_p33zLCfBD7EzlAVeSjG0E_pknbVZlbQFM3Lulc,7794
 mistralai/models/agentscompletionstreamrequest.py,sha256=D1fla5nnnwNKXwHG1w4XVGnqaEvx6sOuhTXdP_e65sM,7239
 mistralai/models/apiendpoint.py,sha256=Hvar5leWsJR_FYb0UzRlSw3vRdBZhk_6BR5r2pIb214,400
@@ -218,6 +227,7 @@ mistralai/models/jobs_api_routes_fine_tuning_start_fine_tuning_jobop.py,sha256=h
 mistralai/models/jobs_api_routes_fine_tuning_unarchive_fine_tuned_modelop.py,sha256=_pkyhD7OzG-59fgcajI9NmSLTLDktkCxXo_IuvWeyfs,636
 mistralai/models/jobs_api_routes_fine_tuning_update_fine_tuned_modelop.py,sha256=s-EYS-Hw0NExYeIyN-3JlHbKmnTmtyB8ljVSfOylqYk,907
 mistralai/models/jobsout.py,sha256=uCKt0aw7yXzI4oLDGeAAEhsRjdRg3g7lPopg0__czTA,818
+mistralai/models/jsonschema.py,sha256=Sh6VCcRxJffd-vXX61GVElbxKNi-j2MKvMUZQcW5EUs,1653
 mistralai/models/legacyjobmetadataout.py,sha256=08zAGNTSrICsK8u2SFFUXiNWF7MCQvezmFQeMQzxsys,4762
 mistralai/models/listfilesout.py,sha256=tW2fNabLKcftc5kytkjwVaChlOzWRL4FKtNzDak9MNs,468
 mistralai/models/metricout.py,sha256=dXQMMU4Nk6-Zr06Jx1TWilFi6cOwiVLjSanCFn0cPxo,2034
@@ -225,8 +235,8 @@ mistralai/models/modelcapabilities.py,sha256=No-Dl09zT1sG4MxsWnx4s8Yo1tUeMQ7k-HR
 mistralai/models/modellist.py,sha256=D4Y784kQkx0ARhofFrpEqGLfxa-jTY8ev0TQMrD_n8I,995
 mistralai/models/prediction.py,sha256=54P1n4Y5pXu4YsFKAcmThj0GyUrWxyOlIfjG5K2htB8,726
 mistralai/models/referencechunk.py,sha256=A9vV5pZv-tUqGlswdu0HOyCYy0Q-UIJY0Oc9ZfM6XJA,519
-mistralai/models/responseformat.py,sha256=C_zO6X4cbT1qSS_q9Qxq64AmtfK10i9tqEz_39ZcFzo,1045
-mistralai/models/responseformats.py,sha256=oeXHoVUoZrZwrz-0cm-rHj5sHygv9MpeqgdummGa8ww,488
+mistralai/models/responseformat.py,sha256=-TAPGth3_FAiNl-kuE4COI5cSP5fxQ7xewFSV989i58,2225
+mistralai/models/responseformats.py,sha256=O9lwS2M9m53DsRxTC4uRP12SvRhgaQoMjIYsDys5A7s,503
 mistralai/models/retrieve_model_v1_models_model_id_getop.py,sha256=N9_JFwiz9tz4zRXJ9c1V0c_anFEVxVzPDoFt2Wrer4M,1388
 mistralai/models/retrievefileout.py,sha256=nAjSITJCHj0daChhpwOZTmps-74mmYZO4IckGA0yIvQ,2644
 mistralai/models/sampletype.py,sha256=zowUiTFxum8fltBs6j__BrFPio-dQdG0CIyLj-5icG8,316
@@ -254,7 +264,7 @@ mistralai/models/wandbintegration.py,sha256=BkLD3r08ToZkMAhPXdnC7bfOGr3banKqt1wV
 mistralai/models/wandbintegrationout.py,sha256=C0HpS8jJGnACs7eWnuIq0qJEroIUAbjkvzfSSkSKS7Q,2274
 mistralai/models_.py,sha256=r0etSSUChK7hxxf7ZyhoeloyE8TyPRL1s5Jh4Jgukbw,44394
 mistralai/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
-mistralai/sdk.py,sha256=9eHH11No72LdVYs7uJXyUqyiZ4hX-qXRtoCxq0LCn3M,5455
+mistralai/sdk.py,sha256=itKygBxr6JLO8f9u0v0m-bsHLOjKutuLalZsg0OLISU,5733
 mistralai/sdkconfiguration.py,sha256=sx6U1xgxFbflhJdOBAeI7isId-8wlMd8NK9pi-JGs1o,1789
 mistralai/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
 mistralai/types/basemodel.py,sha256=PexI39iKiOkIlobB8Ueo0yn8PLHp6_wb-WO-zelNDZY,1170
@@ -274,7 +284,7 @@ mistralai/utils/serializers.py,sha256=BSJT7kBOkNBFyP7KREyMoe14JGbgijD1M6AXFMbdmc
 mistralai/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 mistralai/utils/values.py,sha256=_89YXPTI_BU6SXJBzFR4pIzTCBPQW9tsOTN1jeBBIDs,3428
 mistralai/version.py,sha256=iosXhlXclBwBqlADFKEilxAC2wWKbtuBKi87AmPi7s8,196
-mistralai-1.4.0.dist-info/LICENSE,sha256=rUtQ_9GD0OyLPlb-2uWVdfE87hzudMRmsW-tS-0DK-0,11340
-mistralai-1.4.0.dist-info/METADATA,sha256=6Gs8wKfT4XGnX9TsM5l63GXbcRcI6EnPo-23DI7YIS4,27705
-mistralai-1.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-mistralai-1.4.0.dist-info/RECORD,,
+mistralai-1.5.0.dist-info/LICENSE,sha256=rUtQ_9GD0OyLPlb-2uWVdfE87hzudMRmsW-tS-0DK-0,11340
+mistralai-1.5.0.dist-info/METADATA,sha256=drBwjaz85HBcWlgOsNldybLkbE3KitbeGUsThLU8etU,29251
+mistralai-1.5.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+mistralai-1.5.0.dist-info/RECORD,,