mistralai 1.7.0__tar.gz → 1.7.1__tar.gz

{mistralai-1.7.0 → mistralai-1.7.1}/PKG-INFO

@@ -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 → mistralai-1.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mistralai"
-version = "1.7.0"
+version = "1.7.1"
 description = "Python Client SDK for the Mistral AI API."
 authors = [{ name = "Mistral" },]
 readme = "README-PYPI.md"

{mistralai-1.7.0 → mistralai-1.7.1}/src/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-1.7.0 → mistralai-1.7.1}/src/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-1.7.0 → mistralai-1.7.1}/src/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-1.7.0 → mistralai-1.7.1}/src/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-1.7.1/src/mistralai/models/ocrresponse.py

@@ -0,0 +1,62 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .ocrpageobject import OCRPageObject, OCRPageObjectTypedDict
+from .ocrusageinfo import OCRUsageInfo, OCRUsageInfoTypedDict
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class OCRResponseTypedDict(TypedDict):
+    pages: List[OCRPageObjectTypedDict]
+    r"""List of OCR info for pages."""
+    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):
+    pages: List[OCRPageObject]
+    r"""List of OCR info for pages."""
+
+    model: str
+    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-1.7.0 → mistralai-1.7.1}/src/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/src/mistralai/models/ocrresponse.py

@@ -1,26 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from .ocrpageobject import OCRPageObject, OCRPageObjectTypedDict
-from .ocrusageinfo import OCRUsageInfo, OCRUsageInfoTypedDict
-from mistralai.types import BaseModel
-from typing import List
-from typing_extensions import TypedDict
-
-
-class OCRResponseTypedDict(TypedDict):
-    pages: List[OCRPageObjectTypedDict]
-    r"""List of OCR info for pages."""
-    model: str
-    r"""The model used to generate the OCR."""
-    usage_info: OCRUsageInfoTypedDict
-
-
-class OCRResponse(BaseModel):
-    pages: List[OCRPageObject]
-    r"""List of OCR info for pages."""
-
-    model: str
-    r"""The model used to generate the OCR."""
-
-    usage_info: OCRUsageInfo