mistralai 1.10.0__py3-none-any.whl → 1.11.1__py3-none-any.whl

mistralai/models/embeddingrequest.py

@@ -6,7 +6,7 @@ from .encodingformat import EncodingFormat
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 import pydantic
 from pydantic import model_serializer
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -25,6 +25,7 @@ class EmbeddingRequestTypedDict(TypedDict):
     r"""The ID of the model to be used for embedding."""
     inputs: EmbeddingRequestInputsTypedDict
     r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
     output_dimension: NotRequired[Nullable[int]]
     r"""The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used."""
     output_dtype: NotRequired[EmbeddingDtype]
@@ -38,6 +39,8 @@ class EmbeddingRequest(BaseModel):
     inputs: Annotated[EmbeddingRequestInputs, pydantic.Field(alias="input")]
     r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     output_dimension: OptionalNullable[int] = UNSET
     r"""The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used."""
 
@@ -47,8 +50,13 @@ class EmbeddingRequest(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["output_dimension", "output_dtype", "encoding_format"]
-        nullable_fields = ["output_dimension"]
+        optional_fields = [
+            "metadata",
+            "output_dimension",
+            "output_dtype",
+            "encoding_format",
+        ]
+        nullable_fields = ["metadata", "output_dimension"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/encodingformat.py

@@ -4,4 +4,7 @@ from __future__ import annotations
 from typing import Literal
 
 
-EncodingFormat = Literal["float", "base64"]
+EncodingFormat = Literal[
+    "float",
+    "base64",
+]

mistralai/models/entitytype.py

@@ -5,5 +5,12 @@ from mistralai.types import UnrecognizedStr
 from typing import Literal, Union
 
 
-EntityType = Union[Literal["User", "Workspace", "Org"], UnrecognizedStr]
+EntityType = Union[
+    Literal[
+        "User",
+        "Workspace",
+        "Org",
+    ],
+    UnrecognizedStr,
+]
 r"""The type of entity, used to share a library."""

mistralai/models/filepurpose.py

@@ -5,4 +5,11 @@ from mistralai.types import UnrecognizedStr
 from typing import Literal, Union
 
 
-FilePurpose = Union[Literal["fine-tune", "batch", "ocr"], UnrecognizedStr]
+FilePurpose = Union[
+    Literal[
+        "fine-tune",
+        "batch",
+        "ocr",
+    ],
+    UnrecognizedStr,
+]

mistralai/models/files_api_routes_list_filesop.py

@@ -5,9 +5,8 @@ from .filepurpose import FilePurpose
 from .sampletype import SampleType
 from .source import Source
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
-from mistralai.utils import FieldMetadata, QueryParamMetadata, validate_open_enum
+from mistralai.utils import FieldMetadata, QueryParamMetadata
 from pydantic import model_serializer
-from pydantic.functional_validators import PlainValidator
 from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -39,16 +38,12 @@ class FilesAPIRoutesListFilesRequest(BaseModel):
     ] = True
 
     sample_type: Annotated[
-        OptionalNullable[
-            List[Annotated[SampleType, PlainValidator(validate_open_enum(False))]]
-        ],
+        OptionalNullable[List[SampleType]],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
 
     source: Annotated[
-        OptionalNullable[
-            List[Annotated[Source, PlainValidator(validate_open_enum(False))]]
-        ],
+        OptionalNullable[List[Source]],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
 
@@ -58,9 +53,7 @@ class FilesAPIRoutesListFilesRequest(BaseModel):
     ] = UNSET
 
     purpose: Annotated[
-        Annotated[
-            OptionalNullable[FilePurpose], PlainValidator(validate_open_enum(False))
-        ],
+        OptionalNullable[FilePurpose],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
 

mistralai/models/files_api_routes_upload_fileop.py

@@ -4,8 +4,7 @@ from __future__ import annotations
 from .file import File, FileTypedDict
 from .filepurpose import FilePurpose
 from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, MultipartFormMetadata, validate_open_enum
-from pydantic.functional_validators import PlainValidator
+from mistralai.utils import FieldMetadata, MultipartFormMetadata
 from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -38,7 +37,4 @@ class FilesAPIRoutesUploadFileMultiPartBodyParams(BaseModel):
     ```
     """
 
-    purpose: Annotated[
-        Annotated[Optional[FilePurpose], PlainValidator(validate_open_enum(False))],
-        FieldMetadata(multipart=True),
-    ] = None
+    purpose: Annotated[Optional[FilePurpose], FieldMetadata(multipart=True)] = None

mistralai/models/fileschema.py

@@ -5,10 +5,8 @@ from .filepurpose import FilePurpose
 from .sampletype import SampleType
 from .source import Source
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
-from mistralai.utils import validate_open_enum
 import pydantic
 from pydantic import model_serializer
-from pydantic.functional_validators import PlainValidator
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -47,11 +45,11 @@ class FileSchema(BaseModel):
     filename: str
     r"""The name of the uploaded file."""
 
-    purpose: Annotated[FilePurpose, PlainValidator(validate_open_enum(False))]
+    purpose: FilePurpose
 
-    sample_type: Annotated[SampleType, PlainValidator(validate_open_enum(False))]
+    sample_type: SampleType
 
-    source: Annotated[Source, PlainValidator(validate_open_enum(False))]
+    source: Source
 
     num_lines: OptionalNullable[int] = UNSET
 

mistralai/models/finetuneablemodeltype.py

@@ -4,4 +4,7 @@ from __future__ import annotations
 from typing import Literal
 
 
-FineTuneableModelType = Literal["completion", "classifier"]
+FineTuneableModelType = Literal[
+    "completion",
+    "classifier",
+]

mistralai/models/ftclassifierlossfunction.py

@@ -4,4 +4,7 @@ from __future__ import annotations
 from typing import Literal
 
 
-FTClassifierLossFunction = Literal["single_class", "multi_class"]
+FTClassifierLossFunction = Literal[
+    "single_class",
+    "multi_class",
+]

mistralai/models/ftmodelcard.py

@@ -12,7 +12,7 @@ from typing import List, Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-FTModelCardType = Literal["fine-tuned"]
+FTModelCardType = Literal["fine-tuned",]
 
 
 class FTModelCardTypedDict(TypedDict):

mistralai/models/functioncallentry.py

@@ -12,9 +12,10 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-FunctionCallEntryObject = Literal["entry"]
+FunctionCallEntryObject = Literal["entry",]
 
-FunctionCallEntryType = Literal["function.call"]
+
+FunctionCallEntryType = Literal["function.call",]
 
 
 class FunctionCallEntryTypedDict(TypedDict):

mistralai/models/functioncallevent.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-FunctionCallEventType = Literal["function.call.delta"]
+FunctionCallEventType = Literal["function.call.delta",]
 
 
 class FunctionCallEventTypedDict(TypedDict):

mistralai/models/functionresultentry.py

@@ -8,9 +8,10 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-FunctionResultEntryObject = Literal["entry"]
+FunctionResultEntryObject = Literal["entry",]
 
-FunctionResultEntryType = Literal["function.result"]
+
+FunctionResultEntryType = Literal["function.result",]
 
 
 class FunctionResultEntryTypedDict(TypedDict):

mistralai/models/functiontool.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-FunctionToolType = Literal["function"]
+FunctionToolType = Literal["function",]
 
 
 class FunctionToolTypedDict(TypedDict):

mistralai/models/githubrepositoryin.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-GithubRepositoryInType = Literal["github"]
+GithubRepositoryInType = Literal["github",]
 
 
 class GithubRepositoryInTypedDict(TypedDict):

mistralai/models/githubrepositoryout.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-GithubRepositoryOutType = Literal["github"]
+GithubRepositoryOutType = Literal["github",]
 
 
 class GithubRepositoryOutTypedDict(TypedDict):

mistralai/models/httpvalidationerror.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 from .validationerror import ValidationError
+from dataclasses import dataclass, field
 import httpx
 from mistralai.models import MistralError
 from mistralai.types import BaseModel
@@ -12,8 +13,9 @@ class HTTPValidationErrorData(BaseModel):
     detail: Optional[List[ValidationError]] = None
 
 
+@dataclass(unsafe_hash=True)
 class HTTPValidationError(MistralError):
-    data: HTTPValidationErrorData
+    data: HTTPValidationErrorData = field(hash=False)
 
     def __init__(
         self,
@@ -23,4 +25,4 @@ class HTTPValidationError(MistralError):
     ):
         message = body or raw_response.text
         super().__init__(message, raw_response, body)
-        self.data = data
+        object.__setattr__(self, "data", data)

mistralai/models/imagegenerationtool.py

@@ -6,7 +6,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-ImageGenerationToolType = Literal["image_generation"]
+ImageGenerationToolType = Literal["image_generation",]
 
 
 class ImageGenerationToolTypedDict(TypedDict):

mistralai/models/imageurlchunk.py

@@ -15,7 +15,7 @@ ImageURLChunkImageURLTypedDict = TypeAliasType(
 ImageURLChunkImageURL = TypeAliasType("ImageURLChunkImageURL", Union[ImageURL, str])
 
 
-ImageURLChunkType = Literal["image_url"]
+ImageURLChunkType = Literal["image_url",]
 
 
 class ImageURLChunkTypedDict(TypedDict):

mistralai/models/jobs_api_routes_batch_get_batch_jobop.py

@@ -1,16 +1,53 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mistralai.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class JobsAPIRoutesBatchGetBatchJobRequestTypedDict(TypedDict):
     job_id: str
+    inline: NotRequired[Nullable[bool]]
 
 
 class JobsAPIRoutesBatchGetBatchJobRequest(BaseModel):
     job_id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+
+    inline: Annotated[
+        OptionalNullable[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["inline"]
+        nullable_fields = ["inline"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(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/jobsout.py

@@ -24,7 +24,7 @@ JobsOutData = Annotated[
 ]
 
 
-JobsOutObject = Literal["list"]
+JobsOutObject = Literal["list",]
 
 
 class JobsOutTypedDict(TypedDict):

mistralai/models/legacyjobmetadataout.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-LegacyJobMetadataOutObject = Literal["job.metadata"]
+LegacyJobMetadataOutObject = Literal["job.metadata",]
 
 
 class LegacyJobMetadataOutTypedDict(TypedDict):

mistralai/models/messageinputentry.py

@@ -12,11 +12,17 @@ from typing import List, Literal, Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
-Object = Literal["entry"]
+Object = Literal["entry",]
 
-MessageInputEntryType = Literal["message.input"]
 
-MessageInputEntryRole = Literal["assistant", "user"]
+MessageInputEntryType = Literal["message.input",]
+
+
+MessageInputEntryRole = Literal[
+    "assistant",
+    "user",
+]
+
 
 MessageInputEntryContentTypedDict = TypeAliasType(
     "MessageInputEntryContentTypedDict",

mistralai/models/messageoutputentry.py

@@ -12,11 +12,14 @@ from typing import List, Literal, Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
-MessageOutputEntryObject = Literal["entry"]
+MessageOutputEntryObject = Literal["entry",]
 
-MessageOutputEntryType = Literal["message.output"]
 
-MessageOutputEntryRole = Literal["assistant"]
+MessageOutputEntryType = Literal["message.output",]
+
+
+MessageOutputEntryRole = Literal["assistant",]
+
 
 MessageOutputEntryContentTypedDict = TypeAliasType(
     "MessageOutputEntryContentTypedDict",

mistralai/models/messageoutputevent.py

@@ -9,9 +9,11 @@ from typing import Literal, Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
-MessageOutputEventType = Literal["message.output.delta"]
+MessageOutputEventType = Literal["message.output.delta",]
+
+
+MessageOutputEventRole = Literal["assistant",]
 
-MessageOutputEventRole = Literal["assistant"]
 
 MessageOutputEventContentTypedDict = TypeAliasType(
     "MessageOutputEventContentTypedDict", Union[str, OutputContentChunksTypedDict]

mistralai/models/mistralerror.py

@@ -2,25 +2,29 @@
 
 import httpx
 from typing import Optional
+from dataclasses import dataclass, field
 
 
+@dataclass(unsafe_hash=True)
 class MistralError(Exception):
     """The base class for all HTTP error responses."""
 
     message: str
     status_code: int
     body: str
-    headers: httpx.Headers
-    raw_response: httpx.Response
+    headers: httpx.Headers = field(hash=False)
+    raw_response: httpx.Response = field(hash=False)
 
     def __init__(
         self, message: str, raw_response: httpx.Response, body: Optional[str] = None
     ):
-        self.message = message
-        self.status_code = raw_response.status_code
-        self.body = body if body is not None else raw_response.text
-        self.headers = raw_response.headers
-        self.raw_response = raw_response
+        object.__setattr__(self, "message", message)
+        object.__setattr__(self, "status_code", raw_response.status_code)
+        object.__setattr__(
+            self, "body", body if body is not None else raw_response.text
+        )
+        object.__setattr__(self, "headers", raw_response.headers)
+        object.__setattr__(self, "raw_response", raw_response)
 
     def __str__(self):
         return self.message

mistralai/models/mistralpromptmode.py

@@ -5,4 +5,4 @@ from mistralai.types import UnrecognizedStr
 from typing import Literal, Union
 
 
-MistralPromptMode = Union[Literal["reasoning"], UnrecognizedStr]
+MistralPromptMode = Union[Literal["reasoning",], UnrecognizedStr]

mistralai/models/modelconversation.py

@@ -42,7 +42,7 @@ ModelConversationTools = Annotated[
 ]
 
 
-ModelConversationObject = Literal["conversation"]
+ModelConversationObject = Literal["conversation",]
 
 
 class ModelConversationTypedDict(TypedDict):

mistralai/models/no_response_error.py

@@ -1,12 +1,16 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
+from dataclasses import dataclass
+
+
+@dataclass(unsafe_hash=True)
 class NoResponseError(Exception):
     """Error raised when no HTTP response is received from the server."""
 
     message: str
 
     def __init__(self, message: str = "No response received"):
-        self.message = message
+        object.__setattr__(self, "message", message)
         super().__init__(message)
 
     def __str__(self):

mistralai/models/ocrrequest.py

@@ -22,7 +22,10 @@ Document = TypeAliasType("Document", Union[FileChunk, ImageURLChunk, DocumentURL
 r"""Document to run OCR on"""
 
 
-TableFormat = Literal["markdown", "html"]
+TableFormat = Literal[
+    "markdown",
+    "html",
+]
 
 
 class OCRRequestTypedDict(TypedDict):
@@ -42,6 +45,8 @@ class OCRRequestTypedDict(TypedDict):
     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"""
+    document_annotation_prompt: NotRequired[Nullable[str]]
+    r"""Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided."""
     table_format: NotRequired[Nullable[TableFormat]]
     extract_header: NotRequired[bool]
     extract_footer: NotRequired[bool]
@@ -73,6 +78,9 @@ class OCRRequest(BaseModel):
     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"""
 
+    document_annotation_prompt: OptionalNullable[str] = UNSET
+    r"""Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided."""
+
     table_format: OptionalNullable[TableFormat] = UNSET
 
     extract_header: Optional[bool] = None
@@ -89,6 +97,7 @@ class OCRRequest(BaseModel):
             "image_min_size",
             "bbox_annotation_format",
             "document_annotation_format",
+            "document_annotation_prompt",
             "table_format",
             "extract_header",
             "extract_footer",
@@ -101,6 +110,7 @@ class OCRRequest(BaseModel):
             "image_min_size",
             "bbox_annotation_format",
             "document_annotation_format",
+            "document_annotation_prompt",
             "table_format",
         ]
         null_default_fields = []

mistralai/models/ocrtableobject.py

@@ -7,7 +7,10 @@ from typing import Literal
 from typing_extensions import Annotated, TypedDict
 
 
-Format = Literal["markdown", "html"]
+Format = Literal[
+    "markdown",
+    "html",
+]
 r"""Format of the table"""
 
 

mistralai/models/referencechunk.py

@@ -6,7 +6,7 @@ from typing import List, Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-ReferenceChunkType = Literal["reference"]
+ReferenceChunkType = Literal["reference",]
 
 
 class ReferenceChunkTypedDict(TypedDict):

mistralai/models/requestsource.py

@@ -4,4 +4,8 @@ from __future__ import annotations
 from typing import Literal
 
 
-RequestSource = Literal["api", "playground", "agent_builder_v1"]
+RequestSource = Literal[
+    "api",
+    "playground",
+    "agent_builder_v1",
+]

mistralai/models/responsedoneevent.py

@@ -8,7 +8,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-ResponseDoneEventType = Literal["conversation.response.done"]
+ResponseDoneEventType = Literal["conversation.response.done",]
 
 
 class ResponseDoneEventTypedDict(TypedDict):

mistralai/models/responseerrorevent.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-ResponseErrorEventType = Literal["conversation.response.error"]
+ResponseErrorEventType = Literal["conversation.response.error",]
 
 
 class ResponseErrorEventTypedDict(TypedDict):

mistralai/models/responseformats.py

@@ -4,4 +4,8 @@ from __future__ import annotations
 from typing import Literal
 
 
-ResponseFormats = Literal["text", "json_object", "json_schema"]
+ResponseFormats = Literal[
+    "text",
+    "json_object",
+    "json_schema",
+]

mistralai/models/responsestartedevent.py

@@ -7,7 +7,7 @@ from typing import Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-ResponseStartedEventType = Literal["conversation.response.started"]
+ResponseStartedEventType = Literal["conversation.response.started",]
 
 
 class ResponseStartedEventTypedDict(TypedDict):

mistralai/models/responsevalidationerror.py

@@ -2,10 +2,12 @@
 
 import httpx
 from typing import Optional
+from dataclasses import dataclass
 
 from mistralai.models import MistralError
 
 
+@dataclass(unsafe_hash=True)
 class ResponseValidationError(MistralError):
     """Error raised when there is a type mismatch between the response data and the expected Pydantic model."""