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

mistralai/models/instructrequest.py

@@ -0,0 +1,42 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .assistantmessage import AssistantMessage, AssistantMessageTypedDict
+from .systemmessage import SystemMessage, SystemMessageTypedDict
+from .toolmessage import ToolMessage, ToolMessageTypedDict
+from .usermessage import UserMessage, UserMessageTypedDict
+from mistralai.types import BaseModel
+from mistralai.utils import get_discriminator
+from pydantic import Discriminator, Tag
+from typing import List, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+InstructRequestMessagesTypedDict = TypeAliasType(
+    "InstructRequestMessagesTypedDict",
+    Union[
+        SystemMessageTypedDict,
+        UserMessageTypedDict,
+        AssistantMessageTypedDict,
+        ToolMessageTypedDict,
+    ],
+)
+
+
+InstructRequestMessages = Annotated[
+    Union[
+        Annotated[AssistantMessage, Tag("assistant")],
+        Annotated[SystemMessage, Tag("system")],
+        Annotated[ToolMessage, Tag("tool")],
+        Annotated[UserMessage, Tag("user")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "role", "role")),
+]
+
+
+class InstructRequestTypedDict(TypedDict):
+    messages: List[InstructRequestMessagesTypedDict]
+
+
+class InstructRequest(BaseModel):
+    messages: List[InstructRequestMessages]

mistralai/models/jobin.py

@@ -1,14 +1,23 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .classifiertargetin import ClassifierTargetIn, ClassifierTargetInTypedDict
+from .classifiertrainingparametersin import (
+    ClassifierTrainingParametersIn,
+    ClassifierTrainingParametersInTypedDict,
+)
+from .completiontrainingparametersin import (
+    CompletionTrainingParametersIn,
+    CompletionTrainingParametersInTypedDict,
+)
+from .finetuneablemodeltype import FineTuneableModelType
 from .githubrepositoryin import GithubRepositoryIn, GithubRepositoryInTypedDict
 from .trainingfile import TrainingFile, TrainingFileTypedDict
-from .trainingparametersin import TrainingParametersIn, TrainingParametersInTypedDict
 from .wandbintegration import WandbIntegration, WandbIntegrationTypedDict
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing import List, Optional
-from typing_extensions import NotRequired, TypedDict
+from typing import List, Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
 JobInIntegrationsTypedDict = WandbIntegrationTypedDict
@@ -17,6 +26,20 @@ JobInIntegrationsTypedDict = WandbIntegrationTypedDict
 JobInIntegrations = WandbIntegration
 
 
+HyperparametersTypedDict = TypeAliasType(
+    "HyperparametersTypedDict",
+    Union[
+        ClassifierTrainingParametersInTypedDict, CompletionTrainingParametersInTypedDict
+    ],
+)
+
+
+Hyperparameters = TypeAliasType(
+    "Hyperparameters",
+    Union[ClassifierTrainingParametersIn, CompletionTrainingParametersIn],
+)
+
+
 JobInRepositoriesTypedDict = GithubRepositoryInTypedDict
 
 
@@ -26,8 +49,7 @@ JobInRepositories = GithubRepositoryIn
 class JobInTypedDict(TypedDict):
     model: str
     r"""The name of the model to fine-tune."""
-    hyperparameters: TrainingParametersInTypedDict
-    r"""The fine-tuning hyperparameter settings used in a fine-tune job."""
+    hyperparameters: HyperparametersTypedDict
     training_files: NotRequired[List[TrainingFileTypedDict]]
     validation_files: NotRequired[Nullable[List[str]]]
     r"""A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files."""
@@ -35,17 +57,19 @@ class JobInTypedDict(TypedDict):
     r"""A string that will be added to your fine-tuning model name. For example, a suffix of \"my-great-model\" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...`"""
     integrations: NotRequired[Nullable[List[JobInIntegrationsTypedDict]]]
     r"""A list of integrations to enable for your fine-tuning job."""
-    repositories: NotRequired[List[JobInRepositoriesTypedDict]]
     auto_start: NotRequired[bool]
     r"""This field will be required in a future release."""
+    invalid_sample_skip_percentage: NotRequired[float]
+    job_type: NotRequired[Nullable[FineTuneableModelType]]
+    repositories: NotRequired[Nullable[List[JobInRepositoriesTypedDict]]]
+    classifier_targets: NotRequired[Nullable[List[ClassifierTargetInTypedDict]]]
 
 
 class JobIn(BaseModel):
     model: str
     r"""The name of the model to fine-tune."""
 
-    hyperparameters: TrainingParametersIn
-    r"""The fine-tuning hyperparameter settings used in a fine-tune job."""
+    hyperparameters: Hyperparameters
 
     training_files: Optional[List[TrainingFile]] = None
 
@@ -58,11 +82,17 @@ class JobIn(BaseModel):
     integrations: OptionalNullable[List[JobInIntegrations]] = UNSET
     r"""A list of integrations to enable for your fine-tuning job."""
 
-    repositories: Optional[List[JobInRepositories]] = None
-
     auto_start: Optional[bool] = None
     r"""This field will be required in a future release."""
 
+    invalid_sample_skip_percentage: Optional[float] = 0
+
+    job_type: OptionalNullable[FineTuneableModelType] = UNSET
+
+    repositories: OptionalNullable[List[JobInRepositories]] = UNSET
+
+    classifier_targets: OptionalNullable[List[ClassifierTargetIn]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -70,10 +100,20 @@ class JobIn(BaseModel):
             "validation_files",
             "suffix",
             "integrations",
-            "repositories",
             "auto_start",
+            "invalid_sample_skip_percentage",
+            "job_type",
+            "repositories",
+            "classifier_targets",
+        ]
+        nullable_fields = [
+            "validation_files",
+            "suffix",
+            "integrations",
+            "job_type",
+            "repositories",
+            "classifier_targets",
         ]
-        nullable_fields = ["validation_files", "suffix", "integrations"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/jobs_api_routes_batch_get_batch_jobsop.py

@@ -6,7 +6,7 @@ from datetime import datetime
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mistralai.utils import FieldMetadata, QueryParamMetadata
 from pydantic import model_serializer
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -17,7 +17,7 @@ class JobsAPIRoutesBatchGetBatchJobsRequestTypedDict(TypedDict):
     metadata: NotRequired[Nullable[Dict[str, Any]]]
     created_after: NotRequired[Nullable[datetime]]
     created_by_me: NotRequired[bool]
-    status: NotRequired[Nullable[BatchJobStatus]]
+    status: NotRequired[Nullable[List[BatchJobStatus]]]
 
 
 class JobsAPIRoutesBatchGetBatchJobsRequest(BaseModel):
@@ -52,7 +52,7 @@ class JobsAPIRoutesBatchGetBatchJobsRequest(BaseModel):
     ] = False
 
     status: Annotated[
-        OptionalNullable[BatchJobStatus],
+        OptionalNullable[List[BatchJobStatus]],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = UNSET
 

mistralai/models/jobs_api_routes_fine_tuning_cancel_fine_tuning_jobop.py

@@ -1,9 +1,19 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .classifierdetailedjobout import (
+    ClassifierDetailedJobOut,
+    ClassifierDetailedJobOutTypedDict,
+)
+from .completiondetailedjobout import (
+    CompletionDetailedJobOut,
+    CompletionDetailedJobOutTypedDict,
+)
 from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.utils import FieldMetadata, PathParamMetadata, get_discriminator
+from pydantic import Discriminator, Tag
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 class JobsAPIRoutesFineTuningCancelFineTuningJobRequestTypedDict(TypedDict):
@@ -16,3 +26,20 @@ class JobsAPIRoutesFineTuningCancelFineTuningJobRequest(BaseModel):
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
     r"""The ID of the job to cancel."""
+
+
+JobsAPIRoutesFineTuningCancelFineTuningJobResponseTypedDict = TypeAliasType(
+    "JobsAPIRoutesFineTuningCancelFineTuningJobResponseTypedDict",
+    Union[CompletionDetailedJobOutTypedDict, ClassifierDetailedJobOutTypedDict],
+)
+r"""OK"""
+
+
+JobsAPIRoutesFineTuningCancelFineTuningJobResponse = Annotated[
+    Union[
+        Annotated[ClassifierDetailedJobOut, Tag("classifier")],
+        Annotated[CompletionDetailedJobOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "job_type", "job_type")),
+]
+r"""OK"""

mistralai/models/jobs_api_routes_fine_tuning_create_fine_tuning_jobop.py

@@ -1,21 +1,38 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .jobout import JobOut, JobOutTypedDict
+from .classifierjobout import ClassifierJobOut, ClassifierJobOutTypedDict
+from .completionjobout import CompletionJobOut, CompletionJobOutTypedDict
 from .legacyjobmetadataout import LegacyJobMetadataOut, LegacyJobMetadataOutTypedDict
+from mistralai.utils import get_discriminator
+from pydantic import Discriminator, Tag
 from typing import Union
-from typing_extensions import TypeAliasType
+from typing_extensions import Annotated, TypeAliasType
+
+
+Response1TypedDict = TypeAliasType(
+    "Response1TypedDict", Union[ClassifierJobOutTypedDict, CompletionJobOutTypedDict]
+)
+
+
+Response1 = Annotated[
+    Union[
+        Annotated[ClassifierJobOut, Tag("classifier")],
+        Annotated[CompletionJobOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "job_type", "job_type")),
+]
 
 
 JobsAPIRoutesFineTuningCreateFineTuningJobResponseTypedDict = TypeAliasType(
     "JobsAPIRoutesFineTuningCreateFineTuningJobResponseTypedDict",
-    Union[LegacyJobMetadataOutTypedDict, JobOutTypedDict],
+    Union[LegacyJobMetadataOutTypedDict, Response1TypedDict],
 )
 r"""OK"""
 
 
 JobsAPIRoutesFineTuningCreateFineTuningJobResponse = TypeAliasType(
     "JobsAPIRoutesFineTuningCreateFineTuningJobResponse",
-    Union[LegacyJobMetadataOut, JobOut],
+    Union[LegacyJobMetadataOut, Response1],
 )
 r"""OK"""

mistralai/models/jobs_api_routes_fine_tuning_get_fine_tuning_jobop.py

@@ -1,9 +1,19 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .classifierdetailedjobout import (
+    ClassifierDetailedJobOut,
+    ClassifierDetailedJobOutTypedDict,
+)
+from .completiondetailedjobout import (
+    CompletionDetailedJobOut,
+    CompletionDetailedJobOutTypedDict,
+)
 from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.utils import FieldMetadata, PathParamMetadata, get_discriminator
+from pydantic import Discriminator, Tag
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 class JobsAPIRoutesFineTuningGetFineTuningJobRequestTypedDict(TypedDict):
@@ -16,3 +26,20 @@ class JobsAPIRoutesFineTuningGetFineTuningJobRequest(BaseModel):
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
     r"""The ID of the job to analyse."""
+
+
+JobsAPIRoutesFineTuningGetFineTuningJobResponseTypedDict = TypeAliasType(
+    "JobsAPIRoutesFineTuningGetFineTuningJobResponseTypedDict",
+    Union[CompletionDetailedJobOutTypedDict, ClassifierDetailedJobOutTypedDict],
+)
+r"""OK"""
+
+
+JobsAPIRoutesFineTuningGetFineTuningJobResponse = Annotated[
+    Union[
+        Annotated[ClassifierDetailedJobOut, Tag("classifier")],
+        Annotated[CompletionDetailedJobOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "job_type", "job_type")),
+]
+r"""OK"""

mistralai/models/jobs_api_routes_fine_tuning_get_fine_tuning_jobsop.py

@@ -33,6 +33,7 @@ class JobsAPIRoutesFineTuningGetFineTuningJobsRequestTypedDict(TypedDict):
     r"""The model name used for fine-tuning to filter on. When set, the other results are not displayed."""
     created_after: NotRequired[Nullable[datetime]]
     r"""The date/time to filter on. When set, the results for previous creation times are not displayed."""
+    created_before: NotRequired[Nullable[datetime]]
     created_by_me: NotRequired[bool]
     r"""When set, only return results for jobs created by the API caller. Other results are not displayed."""
     status: NotRequired[Nullable[QueryParamStatus]]
@@ -70,6 +71,11 @@ class JobsAPIRoutesFineTuningGetFineTuningJobsRequest(BaseModel):
     ] = UNSET
     r"""The date/time to filter on. When set, the results for previous creation times are not displayed."""
 
+    created_before: Annotated[
+        OptionalNullable[datetime],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
     created_by_me: Annotated[
         Optional[bool],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -107,6 +113,7 @@ class JobsAPIRoutesFineTuningGetFineTuningJobsRequest(BaseModel):
             "page_size",
             "model",
             "created_after",
+            "created_before",
             "created_by_me",
             "status",
             "wandb_project",
@@ -116,6 +123,7 @@ class JobsAPIRoutesFineTuningGetFineTuningJobsRequest(BaseModel):
         nullable_fields = [
             "model",
             "created_after",
+            "created_before",
             "status",
             "wandb_project",
             "wandb_name",

mistralai/models/jobs_api_routes_fine_tuning_start_fine_tuning_jobop.py

@@ -1,9 +1,19 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .classifierdetailedjobout import (
+    ClassifierDetailedJobOut,
+    ClassifierDetailedJobOutTypedDict,
+)
+from .completiondetailedjobout import (
+    CompletionDetailedJobOut,
+    CompletionDetailedJobOutTypedDict,
+)
 from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.utils import FieldMetadata, PathParamMetadata, get_discriminator
+from pydantic import Discriminator, Tag
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 class JobsAPIRoutesFineTuningStartFineTuningJobRequestTypedDict(TypedDict):
@@ -14,3 +24,20 @@ class JobsAPIRoutesFineTuningStartFineTuningJobRequest(BaseModel):
     job_id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+
+
+JobsAPIRoutesFineTuningStartFineTuningJobResponseTypedDict = TypeAliasType(
+    "JobsAPIRoutesFineTuningStartFineTuningJobResponseTypedDict",
+    Union[CompletionDetailedJobOutTypedDict, ClassifierDetailedJobOutTypedDict],
+)
+r"""OK"""
+
+
+JobsAPIRoutesFineTuningStartFineTuningJobResponse = Annotated[
+    Union[
+        Annotated[ClassifierDetailedJobOut, Tag("classifier")],
+        Annotated[CompletionDetailedJobOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "job_type", "job_type")),
+]
+r"""OK"""

mistralai/models/jobs_api_routes_fine_tuning_update_fine_tuned_modelop.py

@@ -1,10 +1,19 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .classifierftmodelout import ClassifierFTModelOut, ClassifierFTModelOutTypedDict
+from .completionftmodelout import CompletionFTModelOut, CompletionFTModelOutTypedDict
 from .updateftmodelin import UpdateFTModelIn, UpdateFTModelInTypedDict
 from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata, RequestMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.utils import (
+    FieldMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+    get_discriminator,
+)
+from pydantic import Discriminator, Tag
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 class JobsAPIRoutesFineTuningUpdateFineTunedModelRequestTypedDict(TypedDict):
@@ -23,3 +32,20 @@ class JobsAPIRoutesFineTuningUpdateFineTunedModelRequest(BaseModel):
         UpdateFTModelIn,
         FieldMetadata(request=RequestMetadata(media_type="application/json")),
     ]
+
+
+JobsAPIRoutesFineTuningUpdateFineTunedModelResponseTypedDict = TypeAliasType(
+    "JobsAPIRoutesFineTuningUpdateFineTunedModelResponseTypedDict",
+    Union[CompletionFTModelOutTypedDict, ClassifierFTModelOutTypedDict],
+)
+r"""OK"""
+
+
+JobsAPIRoutesFineTuningUpdateFineTunedModelResponse = Annotated[
+    Union[
+        Annotated[ClassifierFTModelOut, Tag("classifier")],
+        Annotated[CompletionFTModelOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "model_type", "model_type")),
+]
+r"""OK"""

mistralai/models/jobsout.py

@@ -1,13 +1,27 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .jobout import JobOut, JobOutTypedDict
+from .classifierjobout import ClassifierJobOut, ClassifierJobOutTypedDict
+from .completionjobout import CompletionJobOut, CompletionJobOutTypedDict
 from mistralai.types import BaseModel
-from mistralai.utils import validate_const
-import pydantic
-from pydantic.functional_validators import AfterValidator
-from typing import List, Literal, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from mistralai.utils import get_discriminator
+from pydantic import Discriminator, Tag
+from typing import List, Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+JobsOutDataTypedDict = TypeAliasType(
+    "JobsOutDataTypedDict", Union[ClassifierJobOutTypedDict, CompletionJobOutTypedDict]
+)
+
+
+JobsOutData = Annotated[
+    Union[
+        Annotated[ClassifierJobOut, Tag("classifier")],
+        Annotated[CompletionJobOut, Tag("completion")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "job_type", "job_type")),
+]
 
 
 JobsOutObject = Literal["list"]
@@ -15,16 +29,13 @@ JobsOutObject = Literal["list"]
 
 class JobsOutTypedDict(TypedDict):
     total: int
-    data: NotRequired[List[JobOutTypedDict]]
-    object: JobsOutObject
+    data: NotRequired[List[JobsOutDataTypedDict]]
+    object: NotRequired[JobsOutObject]
 
 
 class JobsOut(BaseModel):
     total: int
 
-    data: Optional[List[JobOut]] = None
+    data: Optional[List[JobsOutData]] = None
 
-    OBJECT: Annotated[
-        Annotated[Optional[JobsOutObject], AfterValidator(validate_const("list"))],
-        pydantic.Field(alias="object"),
-    ] = "list"
+    object: Optional[JobsOutObject] = "list"

mistralai/models/legacyjobmetadataout.py

@@ -2,12 +2,9 @@
 
 from __future__ import annotations
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
-from mistralai.utils import validate_const
-import pydantic
 from pydantic import model_serializer
-from pydantic.functional_validators import AfterValidator
 from typing import Literal, Optional
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing_extensions import NotRequired, TypedDict
 
 
 LegacyJobMetadataOutObject = Literal["job.metadata"]
@@ -33,7 +30,7 @@ class LegacyJobMetadataOutTypedDict(TypedDict):
     r"""The number of complete passes through the entire training dataset."""
     training_steps: NotRequired[Nullable[int]]
     r"""The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset."""
-    object: LegacyJobMetadataOutObject
+    object: NotRequired[LegacyJobMetadataOutObject]
 
 
 class LegacyJobMetadataOut(BaseModel):
@@ -67,13 +64,7 @@ class LegacyJobMetadataOut(BaseModel):
     training_steps: OptionalNullable[int] = UNSET
     r"""The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset."""
 
-    OBJECT: Annotated[
-        Annotated[
-            Optional[LegacyJobMetadataOutObject],
-            AfterValidator(validate_const("job.metadata")),
-        ],
-        pydantic.Field(alias="object"),
-    ] = "job.metadata"
+    object: Optional[LegacyJobMetadataOutObject] = "job.metadata"
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):

mistralai/models/{classificationobject.py → moderationobject.py}

@@ -6,16 +6,16 @@ from typing import Dict, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class ClassificationObjectTypedDict(TypedDict):
+class ModerationObjectTypedDict(TypedDict):
     categories: NotRequired[Dict[str, bool]]
-    r"""Classifier result thresholded"""
+    r"""Moderation result thresholds"""
     category_scores: NotRequired[Dict[str, float]]
-    r"""Classifier result"""
+    r"""Moderation result"""
 
 
-class ClassificationObject(BaseModel):
+class ModerationObject(BaseModel):
     categories: Optional[Dict[str, bool]] = None
-    r"""Classifier result thresholded"""
+    r"""Moderation result thresholds"""
 
     category_scores: Optional[Dict[str, float]] = None
-    r"""Classifier result"""
+    r"""Moderation result"""

mistralai/models/moderationresponse.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .moderationobject import ModerationObject, ModerationObjectTypedDict
+from mistralai.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class ModerationResponseTypedDict(TypedDict):
+    id: str
+    model: str
+    results: List[ModerationObjectTypedDict]
+
+
+class ModerationResponse(BaseModel):
+    id: str
+
+    model: str
+
+    results: List[ModerationObject]

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 = []