mistralai 1.7.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

mistralai/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "mistralai"
-__version__: str = "1.7.0"
-__openapi_doc_version__: str = "0.0.2"
+__version__: str = "1.7.1"
+__openapi_doc_version__: str = "1.0.0"
 __gen_version__: str = "2.548.6"
-__user_agent__: str = "speakeasy-sdk/python 1.7.0 2.548.6 0.0.2 mistralai"
+__user_agent__: str = "speakeasy-sdk/python 1.7.1 2.548.6 1.0.0 mistralai"
 
 try:
     if __package__ is not None:

mistralai/extra/utils/_pydantic_helper.py

@@ -1,11 +1,12 @@
 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)):
+    if isinstance(schema_node, (str, bool)) or schema_node is None:
         return schema_node
     if isinstance(schema_node, dict):
         if "type" in schema_node and schema_node["type"] == "object":

mistralai/models/ocrimageobject.py

@@ -19,6 +19,8 @@ class OCRImageObjectTypedDict(TypedDict):
     r"""Y coordinate of bottom-right corner of the extracted image"""
     image_base64: NotRequired[Nullable[str]]
     r"""Base64 string of the extracted image"""
+    image_annotation: NotRequired[Nullable[str]]
+    r"""Annotation of the extracted image in json str"""
 
 
 class OCRImageObject(BaseModel):
@@ -40,15 +42,19 @@ class OCRImageObject(BaseModel):
     image_base64: OptionalNullable[str] = UNSET
     r"""Base64 string of the extracted image"""
 
+    image_annotation: OptionalNullable[str] = UNSET
+    r"""Annotation of the extracted image in json str"""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["image_base64"]
+        optional_fields = ["image_base64", "image_annotation"]
         nullable_fields = [
             "top_left_x",
             "top_left_y",
             "bottom_right_x",
             "bottom_right_y",
             "image_base64",
+            "image_annotation",
         ]
         null_default_fields = []
 

mistralai/models/ocrrequest.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 from .documenturlchunk import DocumentURLChunk, DocumentURLChunkTypedDict
 from .imageurlchunk import ImageURLChunk, ImageURLChunkTypedDict
+from .responseformat import ResponseFormat, ResponseFormatTypedDict
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
 from typing import List, Optional, Union
@@ -32,6 +33,10 @@ class OCRRequestTypedDict(TypedDict):
     r"""Max images to extract"""
     image_min_size: NotRequired[Nullable[int]]
     r"""Minimum height and width of image to extract"""
+    bbox_annotation_format: NotRequired[Nullable[ResponseFormatTypedDict]]
+    r"""Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field"""
+    document_annotation_format: NotRequired[Nullable[ResponseFormatTypedDict]]
+    r"""Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field"""
 
 
 class OCRRequest(BaseModel):
@@ -54,6 +59,12 @@ class OCRRequest(BaseModel):
     image_min_size: OptionalNullable[int] = UNSET
     r"""Minimum height and width of image to extract"""
 
+    bbox_annotation_format: OptionalNullable[ResponseFormat] = UNSET
+    r"""Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field"""
+
+    document_annotation_format: OptionalNullable[ResponseFormat] = UNSET
+    r"""Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field"""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -62,6 +73,8 @@ class OCRRequest(BaseModel):
             "include_image_base64",
             "image_limit",
             "image_min_size",
+            "bbox_annotation_format",
+            "document_annotation_format",
         ]
         nullable_fields = [
             "model",
@@ -69,6 +82,8 @@ class OCRRequest(BaseModel):
             "include_image_base64",
             "image_limit",
             "image_min_size",
+            "bbox_annotation_format",
+            "document_annotation_format",
         ]
         null_default_fields = []
 

mistralai/models/ocrresponse.py

@@ -3,9 +3,10 @@
 from __future__ import annotations
 from .ocrpageobject import OCRPageObject, OCRPageObjectTypedDict
 from .ocrusageinfo import OCRUsageInfo, OCRUsageInfoTypedDict
-from mistralai.types import BaseModel
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
 from typing import List
-from typing_extensions import TypedDict
+from typing_extensions import NotRequired, TypedDict
 
 
 class OCRResponseTypedDict(TypedDict):
@@ -14,6 +15,8 @@ class OCRResponseTypedDict(TypedDict):
     model: str
     r"""The model used to generate the OCR."""
     usage_info: OCRUsageInfoTypedDict
+    document_annotation: NotRequired[Nullable[str]]
+    r"""Formatted response in the request_format if provided in json str"""
 
 
 class OCRResponse(BaseModel):
@@ -24,3 +27,36 @@ class OCRResponse(BaseModel):
     r"""The model used to generate the OCR."""
 
     usage_info: OCRUsageInfo
+
+    document_annotation: OptionalNullable[str] = UNSET
+    r"""Formatted response in the request_format if provided in json str"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["document_annotation"]
+        nullable_fields = ["document_annotation"]
+        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/ocr.py

@@ -21,6 +21,12 @@ class Ocr(BaseSDK):
         include_image_base64: OptionalNullable[bool] = UNSET,
         image_limit: OptionalNullable[int] = UNSET,
         image_min_size: OptionalNullable[int] = UNSET,
+        bbox_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
+        document_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -35,6 +41,8 @@ class Ocr(BaseSDK):
         :param include_image_base64: Include image URLs in response
         :param image_limit: Max images to extract
         :param image_min_size: Minimum height and width of image to extract
+        :param bbox_annotation_format: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
+        :param document_annotation_format: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -58,6 +66,12 @@ class Ocr(BaseSDK):
             include_image_base64=include_image_base64,
             image_limit=image_limit,
             image_min_size=image_min_size,
+            bbox_annotation_format=utils.get_pydantic_model(
+                bbox_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
+            document_annotation_format=utils.get_pydantic_model(
+                document_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
         )
 
         req = self._build_request(
@@ -139,6 +153,12 @@ class Ocr(BaseSDK):
         include_image_base64: OptionalNullable[bool] = UNSET,
         image_limit: OptionalNullable[int] = UNSET,
         image_min_size: OptionalNullable[int] = UNSET,
+        bbox_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
+        document_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -153,6 +173,8 @@ class Ocr(BaseSDK):
         :param include_image_base64: Include image URLs in response
         :param image_limit: Max images to extract
         :param image_min_size: Minimum height and width of image to extract
+        :param bbox_annotation_format: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
+        :param document_annotation_format: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -176,6 +198,12 @@ class Ocr(BaseSDK):
             include_image_base64=include_image_base64,
             image_limit=image_limit,
             image_min_size=image_min_size,
+            bbox_annotation_format=utils.get_pydantic_model(
+                bbox_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
+            document_annotation_format=utils.get_pydantic_model(
+                document_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
         )
 
         req = self._build_request_async(

{mistralai-1.7.0.dist-info → mistralai-1.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mistralai
-Version: 1.7.0
+Version: 1.7.1
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
 Requires-Python: >=3.9

{mistralai-1.7.0.dist-info → mistralai-1.7.1.dist-info}/RECORD

@@ -139,7 +139,7 @@ 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=z3AUFDpRJHj2m3h5PklvUeEcGohY0cfph4jL6-nGIzs,2812
-mistralai/_version.py,sha256=yCLnNFGE0880iq0PxssvV7s0LK7AVA_trjwe6aUNyxQ,460
+mistralai/_version.py,sha256=SPvJqmP-liALw_gV7djYQ0NmHgy9bNFtTsm0WPhGtQM,460
 mistralai/agents.py,sha256=o_apyuwiDzxv-U252T84ynAHCb5fn1q7MMXqrZ4oHLo,32652
 mistralai/async_client.py,sha256=KUdYxIIqoD6L7vB0EGwUR6lQ0NK5iCTHjnLVR9CVcJY,355
 mistralai/basesdk.py,sha256=GsU5bp8O5fBCl34tKxaYmeYSIIM971eAPeFBBC_BpFo,12191
@@ -155,7 +155,7 @@ mistralai/extra/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 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/_pydantic_helper.py,sha256=_mzrbZGU07M96CzcxgjcV25NtIGu5EUfotaN8NDUoFc,883
 mistralai/extra/utils/response_format.py,sha256=uDNpvOHhk2se3JTXweWYMbnkyOcOqhMe2yxZ2lYNe1k,913
 mistralai/files.py,sha256=uejTIBoumK7wMp51e9F2TZsiRDXX9NRnBGgMuaM21eg,45763
 mistralai/fim.py,sha256=UMx-bFYbaSyANZug8VrCabHsqePdiHoYQO1YMKB2MvY,27935
@@ -258,11 +258,11 @@ mistralai/models/modelcapabilities.py,sha256=No-Dl09zT1sG4MxsWnx4s8Yo1tUeMQ7k-HR
 mistralai/models/modellist.py,sha256=D4Y784kQkx0ARhofFrpEqGLfxa-jTY8ev0TQMrD_n8I,995
 mistralai/models/moderationobject.py,sha256=mmzFEcccsT7G9PjmQrsYMijmICbfBtUpVN_ZisuhYbY,655
 mistralai/models/moderationresponse.py,sha256=kxIRI3UJdddj2Hz-E9q21gKQAbacxZoG4hdoZjrae5M,508
-mistralai/models/ocrimageobject.py,sha256=QDylsNCXy78rWLHuE4CrnQAPXnubz0-FN1wQXtsVsDA,2534
+mistralai/models/ocrimageobject.py,sha256=vnBLzA3p7KlpfNYMq1QJYiyA6YDpmWmL2J4SX3CIdQs,2802
 mistralai/models/ocrpagedimensions.py,sha256=oP4v80I8d6ZELSZt6cRoECd6uIONgdyCeeFalm-4OvM,609
 mistralai/models/ocrpageobject.py,sha256=s0OzcCA0cLTFYahNOr0-r4ds7WOsXYhEx-QcNLngW7M,2085
-mistralai/models/ocrrequest.py,sha256=KKFFvxsGsOQKAYFpuZ02-VsiJWNawlIIz-7dPPtNklU,3112
-mistralai/models/ocrresponse.py,sha256=JpI9Yl6fYeGf6Wsn4M4Z-i6Ir2qAlMKFQnVXqsLiC5Y,752
+mistralai/models/ocrrequest.py,sha256=leCP781cr_ruG_QFtvgn84iDa_CIGEQh-N5xpB0hld0,4242
+mistralai/models/ocrresponse.py,sha256=yFjiKSEtdyYkswhEW3lA51Fg2yAWk0s_tJV_QsYMxR0,2042
 mistralai/models/ocrusageinfo.py,sha256=cWtxHxXyJn3U1qJgG-XU-1xfC7poGHvhVtPqdrFrfII,1571
 mistralai/models/prediction.py,sha256=BgWbbeSi1eD9Rh1xk8srXlRgD7Xooj8nLsbSQ21pNRo,718
 mistralai/models/referencechunk.py,sha256=A9vV5pZv-tUqGlswdu0HOyCYy0Q-UIJY0Oc9ZfM6XJA,519
@@ -292,7 +292,7 @@ mistralai/models/validationerror.py,sha256=DouDBJmBhbW4KPsF5rZEyBdnB_adC-l32kuHC
 mistralai/models/wandbintegration.py,sha256=X8V86L3EwheoI-0LI7zwmTtn_4SKz5s62SJN3x5BTxE,2153
 mistralai/models/wandbintegrationout.py,sha256=wohSfHGF8Y9OfIhM1qr9mssLRg63b3CMLDpi4TQKYEk,2111
 mistralai/models_.py,sha256=2tiJEMwjixY0Rz5dDt4gDQNEu9peecly2zWmi7YeQhQ,46398
-mistralai/ocr.py,sha256=R4afXZ1Pk1f6k7Acady1HwRdW-kZXzs7d_Isa7oxJpo,10051
+mistralai/ocr.py,sha256=GvG5SMy85s3xUTGLSnQ3h9GkNYw9KBy8umBnkC9Ciho,11991
 mistralai/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
 mistralai/sdk.py,sha256=q18oi4qj0PU6fsB_5BaWy-18bGzLxOgMlkSvEgCW4MY,6453
 mistralai/sdkconfiguration.py,sha256=88GOgda6cRq40OSFI5FIarLvGNrMaHTzinPI_GyqTvk,1873
@@ -314,7 +314,7 @@ mistralai/utils/serializers.py,sha256=EGH40Pgp3sSK9uM4PxL7_SYzSHtmo-Uy6QIE5xLVg6
 mistralai/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 mistralai/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
 mistralai/version.py,sha256=iosXhlXclBwBqlADFKEilxAC2wWKbtuBKi87AmPi7s8,196
-mistralai-1.7.0.dist-info/LICENSE,sha256=rUtQ_9GD0OyLPlb-2uWVdfE87hzudMRmsW-tS-0DK-0,11340
-mistralai-1.7.0.dist-info/METADATA,sha256=PLOAvlIlQ-AMv1pfbcf8hbg2rwkat9AKjtyGjSZXLM0,30328
-mistralai-1.7.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-mistralai-1.7.0.dist-info/RECORD,,
+mistralai-1.7.1.dist-info/LICENSE,sha256=rUtQ_9GD0OyLPlb-2uWVdfE87hzudMRmsW-tS-0DK-0,11340
+mistralai-1.7.1.dist-info/METADATA,sha256=izeRtogP3xYzTKTnFXa8BLUylIaTAiUZbRJaU6Dtgl4,30328
+mistralai-1.7.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mistralai-1.7.1.dist-info/RECORD,,

{mistralai-1.7.0.dist-info → mistralai-1.7.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any