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

mistralai/models/conversationrestartstreamrequest.py

@@ -3,8 +3,9 @@
 from __future__ import annotations
 from .completionargs import CompletionArgs, CompletionArgsTypedDict
 from .conversationinputs import ConversationInputs, ConversationInputsTypedDict
-from mistralai.types import BaseModel
-from typing import Literal, Optional
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Any, Dict, Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
@@ -22,6 +23,10 @@ class ConversationRestartStreamRequestTypedDict(TypedDict):
     handoff_execution: NotRequired[ConversationRestartStreamRequestHandoffExecution]
     completion_args: NotRequired[CompletionArgsTypedDict]
     r"""White-listed arguments from the completion API"""
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
+    r"""Custom metadata for the conversation."""
+    agent_version: NotRequired[Nullable[int]]
+    r"""Specific version of the agent to use when restarting. If not provided, uses the current version."""
 
 
 class ConversationRestartStreamRequest(BaseModel):
@@ -42,3 +47,46 @@ class ConversationRestartStreamRequest(BaseModel):
 
     completion_args: Optional[CompletionArgs] = None
     r"""White-listed arguments from the completion API"""
+
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+    r"""Custom metadata for the conversation."""
+
+    agent_version: OptionalNullable[int] = UNSET
+    r"""Specific version of the agent to use when restarting. If not provided, uses the current version."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "stream",
+            "store",
+            "handoff_execution",
+            "completion_args",
+            "metadata",
+            "agent_version",
+        ]
+        nullable_fields = ["metadata", "agent_version"]
+        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/conversationstreamrequest.py

@@ -12,7 +12,7 @@ from .websearchtool import WebSearchTool, WebSearchToolTypedDict
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mistralai.utils import get_discriminator
 from pydantic import Discriminator, Tag, model_serializer
-from typing import List, Literal, Optional, Union
+from typing import Any, Dict, List, Literal, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -50,11 +50,14 @@ class ConversationStreamRequestTypedDict(TypedDict):
     store: NotRequired[Nullable[bool]]
     handoff_execution: NotRequired[Nullable[ConversationStreamRequestHandoffExecution]]
     instructions: NotRequired[Nullable[str]]
-    tools: NotRequired[Nullable[List[ConversationStreamRequestToolsTypedDict]]]
+    tools: NotRequired[List[ConversationStreamRequestToolsTypedDict]]
+    r"""List of tools which are available to the model during the conversation."""
     completion_args: NotRequired[Nullable[CompletionArgsTypedDict]]
     name: NotRequired[Nullable[str]]
     description: NotRequired[Nullable[str]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
     agent_id: NotRequired[Nullable[str]]
+    agent_version: NotRequired[Nullable[int]]
     model: NotRequired[Nullable[str]]
 
 
@@ -71,7 +74,8 @@ class ConversationStreamRequest(BaseModel):
 
     instructions: OptionalNullable[str] = UNSET
 
-    tools: OptionalNullable[List[ConversationStreamRequestTools]] = UNSET
+    tools: Optional[List[ConversationStreamRequestTools]] = None
+    r"""List of tools which are available to the model during the conversation."""
 
     completion_args: OptionalNullable[CompletionArgs] = UNSET
 
@@ -79,8 +83,12 @@ class ConversationStreamRequest(BaseModel):
 
     description: OptionalNullable[str] = UNSET
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     agent_id: OptionalNullable[str] = UNSET
 
+    agent_version: OptionalNullable[int] = UNSET
+
     model: OptionalNullable[str] = UNSET
 
     @model_serializer(mode="wrap")
@@ -94,18 +102,21 @@ class ConversationStreamRequest(BaseModel):
             "completion_args",
             "name",
             "description",
+            "metadata",
             "agent_id",
+            "agent_version",
             "model",
         ]
         nullable_fields = [
             "store",
             "handoff_execution",
             "instructions",
-            "tools",
             "completion_args",
             "name",
             "description",
+            "metadata",
             "agent_id",
+            "agent_version",
             "model",
         ]
         null_default_fields = []

mistralai/models/documentout.py

@@ -4,20 +4,21 @@ from __future__ import annotations
 from datetime import datetime
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
+from typing import Any, Dict
 from typing_extensions import NotRequired, TypedDict
 
 
 class DocumentOutTypedDict(TypedDict):
     id: str
     library_id: str
-    hash: str
-    mime_type: str
-    extension: str
-    size: int
+    hash: Nullable[str]
+    mime_type: Nullable[str]
+    extension: Nullable[str]
+    size: Nullable[int]
     name: str
     created_at: datetime
     processing_status: str
-    uploaded_by_id: str
+    uploaded_by_id: Nullable[str]
     uploaded_by_type: str
     tokens_processing_total: int
     summary: NotRequired[Nullable[str]]
@@ -25,6 +26,8 @@ class DocumentOutTypedDict(TypedDict):
     number_of_pages: NotRequired[Nullable[int]]
     tokens_processing_main_content: NotRequired[Nullable[int]]
     tokens_processing_summary: NotRequired[Nullable[int]]
+    url: NotRequired[Nullable[str]]
+    attributes: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class DocumentOut(BaseModel):
@@ -32,13 +35,13 @@ class DocumentOut(BaseModel):
 
     library_id: str
 
-    hash: str
+    hash: Nullable[str]
 
-    mime_type: str
+    mime_type: Nullable[str]
 
-    extension: str
+    extension: Nullable[str]
 
-    size: int
+    size: Nullable[int]
 
     name: str
 
@@ -46,7 +49,7 @@ class DocumentOut(BaseModel):
 
     processing_status: str
 
-    uploaded_by_id: str
+    uploaded_by_id: Nullable[str]
 
     uploaded_by_type: str
 
@@ -62,6 +65,10 @@ class DocumentOut(BaseModel):
 
     tokens_processing_summary: OptionalNullable[int] = UNSET
 
+    url: OptionalNullable[str] = UNSET
+
+    attributes: OptionalNullable[Dict[str, Any]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -70,13 +77,22 @@ class DocumentOut(BaseModel):
             "number_of_pages",
             "tokens_processing_main_content",
             "tokens_processing_summary",
+            "url",
+            "attributes",
         ]
         nullable_fields = [
+            "hash",
+            "mime_type",
+            "extension",
+            "size",
             "summary",
             "last_processed_at",
             "number_of_pages",
+            "uploaded_by_id",
             "tokens_processing_main_content",
             "tokens_processing_summary",
+            "url",
+            "attributes",
         ]
         null_default_fields = []
 

mistralai/models/documentupdatein.py

@@ -1,22 +1,43 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from datetime import datetime
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing_extensions import NotRequired, TypedDict
+from typing import Dict, List, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AttributesTypedDict = TypeAliasType(
+    "AttributesTypedDict",
+    Union[
+        bool, str, int, float, datetime, List[str], List[int], List[float], List[bool]
+    ],
+)
+
+
+Attributes = TypeAliasType(
+    "Attributes",
+    Union[
+        bool, str, int, float, datetime, List[str], List[int], List[float], List[bool]
+    ],
+)
 
 
 class DocumentUpdateInTypedDict(TypedDict):
     name: NotRequired[Nullable[str]]
+    attributes: NotRequired[Nullable[Dict[str, AttributesTypedDict]]]
 
 
 class DocumentUpdateIn(BaseModel):
     name: OptionalNullable[str] = UNSET
 
+    attributes: OptionalNullable[Dict[str, Attributes]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["name"]
-        nullable_fields = ["name"]
+        optional_fields = ["name", "attributes"]
+        nullable_fields = ["name", "attributes"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/embeddingrequest.py

@@ -13,33 +13,33 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 EmbeddingRequestInputsTypedDict = TypeAliasType(
     "EmbeddingRequestInputsTypedDict", Union[str, List[str]]
 )
-r"""Text to embed."""
+r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
 
 
 EmbeddingRequestInputs = TypeAliasType("EmbeddingRequestInputs", Union[str, List[str]])
-r"""Text to embed."""
+r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
 
 
 class EmbeddingRequestTypedDict(TypedDict):
     model: str
-    r"""ID of the model to use."""
+    r"""The ID of the model to be used for embedding."""
     inputs: EmbeddingRequestInputsTypedDict
-    r"""Text to embed."""
+    r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
     output_dimension: NotRequired[Nullable[int]]
-    r"""The dimension of the output embeddings."""
+    r"""The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used."""
     output_dtype: NotRequired[EmbeddingDtype]
     encoding_format: NotRequired[EncodingFormat]
 
 
 class EmbeddingRequest(BaseModel):
     model: str
-    r"""ID of the model to use."""
+    r"""The ID of the model to be used for embedding."""
 
     inputs: Annotated[EmbeddingRequestInputs, pydantic.Field(alias="input")]
-    r"""Text to embed."""
+    r"""The text content to be embedded, can be a string or an array of strings for fast processing in bulk."""
 
     output_dimension: OptionalNullable[int] = UNSET
-    r"""The dimension of the output embeddings."""
+    r"""The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used."""
 
     output_dtype: Optional[EmbeddingDtype] = None
 

mistralai/models/files_api_routes_list_filesop.py

@@ -15,6 +15,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 class FilesAPIRoutesListFilesRequestTypedDict(TypedDict):
     page: NotRequired[int]
     page_size: NotRequired[int]
+    include_total: NotRequired[bool]
     sample_type: NotRequired[Nullable[List[SampleType]]]
     source: NotRequired[Nullable[List[Source]]]
     search: NotRequired[Nullable[str]]
@@ -32,6 +33,11 @@ class FilesAPIRoutesListFilesRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = 100
 
+    include_total: Annotated[
+        Optional[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = True
+
     sample_type: Annotated[
         OptionalNullable[
             List[Annotated[SampleType, PlainValidator(validate_open_enum(False))]]
@@ -63,6 +69,7 @@ class FilesAPIRoutesListFilesRequest(BaseModel):
         optional_fields = [
             "page",
             "page_size",
+            "include_total",
             "sample_type",
             "source",
             "search",

mistralai/models/fimcompletionrequest.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
@@ -21,10 +21,7 @@ r"""Stop generation if this token is detected. Or if one of these tokens is dete
 
 class FIMCompletionRequestTypedDict(TypedDict):
     model: str
-    r"""ID of the model to use. Only compatible for now with:
-    - `codestral-2405`
-    - `codestral-latest`
-    """
+    r"""ID of the model with FIM to use."""
     prompt: str
     r"""The text/code to complete."""
     temperature: NotRequired[Nullable[float]]
@@ -39,6 +36,7 @@ class FIMCompletionRequestTypedDict(TypedDict):
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
     random_seed: NotRequired[Nullable[int]]
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
     suffix: NotRequired[Nullable[str]]
     r"""Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`."""
     min_tokens: NotRequired[Nullable[int]]
@@ -47,10 +45,7 @@ class FIMCompletionRequestTypedDict(TypedDict):
 
 class FIMCompletionRequest(BaseModel):
     model: str
-    r"""ID of the model to use. Only compatible for now with:
-    - `codestral-2405`
-    - `codestral-latest`
-    """
+    r"""ID of the model with FIM to use."""
 
     prompt: str
     r"""The text/code to complete."""
@@ -73,6 +68,8 @@ class FIMCompletionRequest(BaseModel):
     random_seed: OptionalNullable[int] = UNSET
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     suffix: OptionalNullable[str] = UNSET
     r"""Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`."""
 
@@ -88,6 +85,7 @@ class FIMCompletionRequest(BaseModel):
             "stream",
             "stop",
             "random_seed",
+            "metadata",
             "suffix",
             "min_tokens",
         ]
@@ -95,6 +93,7 @@ class FIMCompletionRequest(BaseModel):
             "temperature",
             "max_tokens",
             "random_seed",
+            "metadata",
             "suffix",
             "min_tokens",
         ]

mistralai/models/fimcompletionstreamrequest.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
@@ -21,10 +21,7 @@ r"""Stop generation if this token is detected. Or if one of these tokens is dete
 
 class FIMCompletionStreamRequestTypedDict(TypedDict):
     model: str
-    r"""ID of the model to use. Only compatible for now with:
-    - `codestral-2405`
-    - `codestral-latest`
-    """
+    r"""ID of the model with FIM to use."""
     prompt: str
     r"""The text/code to complete."""
     temperature: NotRequired[Nullable[float]]
@@ -38,6 +35,7 @@ class FIMCompletionStreamRequestTypedDict(TypedDict):
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
     random_seed: NotRequired[Nullable[int]]
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
     suffix: NotRequired[Nullable[str]]
     r"""Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`."""
     min_tokens: NotRequired[Nullable[int]]
@@ -46,10 +44,7 @@ class FIMCompletionStreamRequestTypedDict(TypedDict):
 
 class FIMCompletionStreamRequest(BaseModel):
     model: str
-    r"""ID of the model to use. Only compatible for now with:
-    - `codestral-2405`
-    - `codestral-latest`
-    """
+    r"""ID of the model with FIM to use."""
 
     prompt: str
     r"""The text/code to complete."""
@@ -71,6 +66,8 @@ class FIMCompletionStreamRequest(BaseModel):
     random_seed: OptionalNullable[int] = UNSET
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     suffix: OptionalNullable[str] = UNSET
     r"""Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`."""
 
@@ -86,6 +83,7 @@ class FIMCompletionStreamRequest(BaseModel):
             "stream",
             "stop",
             "random_seed",
+            "metadata",
             "suffix",
             "min_tokens",
         ]
@@ -93,6 +91,7 @@ class FIMCompletionStreamRequest(BaseModel):
             "temperature",
             "max_tokens",
             "random_seed",
+            "metadata",
             "suffix",
             "min_tokens",
         ]

mistralai/models/libraries_documents_list_v1op.py

@@ -13,6 +13,7 @@ class LibrariesDocumentsListV1RequestTypedDict(TypedDict):
     search: NotRequired[Nullable[str]]
     page_size: NotRequired[int]
     page: NotRequired[int]
+    filters_attributes: NotRequired[Nullable[str]]
     sort_by: NotRequired[str]
     sort_order: NotRequired[str]
 
@@ -37,6 +38,11 @@ class LibrariesDocumentsListV1Request(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = 0
 
+    filters_attributes: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
     sort_by: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -49,8 +55,15 @@ class LibrariesDocumentsListV1Request(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["search", "page_size", "page", "sort_by", "sort_order"]
-        nullable_fields = ["search"]
+        optional_fields = [
+            "search",
+            "page_size",
+            "page",
+            "filters_attributes",
+            "sort_by",
+            "sort_order",
+        ]
+        nullable_fields = ["search", "filters_attributes"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/libraryout.py

@@ -12,18 +12,19 @@ class LibraryOutTypedDict(TypedDict):
     name: str
     created_at: datetime
     updated_at: datetime
-    owner_id: str
+    owner_id: Nullable[str]
     owner_type: str
     total_size: int
     nb_documents: int
     chunk_size: Nullable[int]
     emoji: NotRequired[Nullable[str]]
     description: NotRequired[Nullable[str]]
-    generated_name: NotRequired[Nullable[str]]
     generated_description: NotRequired[Nullable[str]]
     explicit_user_members_count: NotRequired[Nullable[int]]
     explicit_workspace_members_count: NotRequired[Nullable[int]]
     org_sharing_role: NotRequired[Nullable[str]]
+    generated_name: NotRequired[Nullable[str]]
+    r"""Generated Name"""
 
 
 class LibraryOut(BaseModel):
@@ -35,7 +36,7 @@ class LibraryOut(BaseModel):
 
     updated_at: datetime
 
-    owner_id: str
+    owner_id: Nullable[str]
 
     owner_type: str
 
@@ -49,8 +50,6 @@ class LibraryOut(BaseModel):
 
     description: OptionalNullable[str] = UNSET
 
-    generated_name: OptionalNullable[str] = UNSET
-
     generated_description: OptionalNullable[str] = UNSET
 
     explicit_user_members_count: OptionalNullable[int] = UNSET
@@ -59,26 +58,30 @@ class LibraryOut(BaseModel):
 
     org_sharing_role: OptionalNullable[str] = UNSET
 
+    generated_name: OptionalNullable[str] = UNSET
+    r"""Generated Name"""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
             "emoji",
             "description",
-            "generated_name",
             "generated_description",
             "explicit_user_members_count",
             "explicit_workspace_members_count",
             "org_sharing_role",
+            "generated_name",
         ]
         nullable_fields = [
+            "owner_id",
             "chunk_size",
             "emoji",
             "description",
-            "generated_name",
             "generated_description",
             "explicit_user_members_count",
             "explicit_workspace_members_count",
             "org_sharing_role",
+            "generated_name",
         ]
         null_default_fields = []
 

mistralai/models/listfilesout.py

@@ -2,15 +2,16 @@
 
 from __future__ import annotations
 from .fileschema import FileSchema, FileSchemaTypedDict
-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 ListFilesOutTypedDict(TypedDict):
     data: List[FileSchemaTypedDict]
     object: str
-    total: int
+    total: NotRequired[Nullable[int]]
 
 
 class ListFilesOut(BaseModel):
@@ -18,4 +19,34 @@ class ListFilesOut(BaseModel):
 
     object: str
 
-    total: int
+    total: OptionalNullable[int] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["total"]
+        nullable_fields = ["total"]
+        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