mistralai 1.0.2__py3-none-any.whl → 1.1.0__py3-none-any.whl

mistralai/models/agentscompletionrequest.py

@@ -4,12 +4,14 @@ from __future__ import annotations
 from .assistantmessage import AssistantMessage, AssistantMessageTypedDict
 from .responseformat import ResponseFormat, ResponseFormatTypedDict
 from .tool import Tool, ToolTypedDict
+from .toolchoice import ToolChoice, ToolChoiceTypedDict
+from .toolchoiceenum import ToolChoiceEnum
 from .toolmessage import ToolMessage, ToolMessageTypedDict
 from .usermessage import UserMessage, UserMessageTypedDict
 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, TypedDict, Union
+from typing import List, Optional, TypedDict, Union
 from typing_extensions import Annotated, NotRequired
 
 
@@ -21,13 +23,26 @@ AgentsCompletionRequestStop = Union[str, List[str]]
 r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
 
 
-AgentsCompletionRequestMessagesTypedDict = Union[UserMessageTypedDict, AssistantMessageTypedDict, ToolMessageTypedDict]
+AgentsCompletionRequestMessagesTypedDict = Union[
+    UserMessageTypedDict, AssistantMessageTypedDict, ToolMessageTypedDict
+]
 
 
-AgentsCompletionRequestMessages = Annotated[Union[Annotated[AssistantMessage, Tag("assistant")], Annotated[ToolMessage, Tag("tool")], Annotated[UserMessage, Tag("user")]], Discriminator(lambda m: get_discriminator(m, "role", "role"))]
+AgentsCompletionRequestMessages = Annotated[
+    Union[
+        Annotated[AssistantMessage, Tag("assistant")],
+        Annotated[ToolMessage, Tag("tool")],
+        Annotated[UserMessage, Tag("user")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "role", "role")),
+]
 
 
-AgentsCompletionRequestToolChoice = Literal["auto", "none", "any"]
+AgentsCompletionRequestToolChoiceTypedDict = Union[ToolChoiceTypedDict, ToolChoiceEnum]
+
+
+AgentsCompletionRequestToolChoice = Union[ToolChoice, ToolChoiceEnum]
+
 
 class AgentsCompletionRequestTypedDict(TypedDict):
     messages: List[AgentsCompletionRequestMessagesTypedDict]
@@ -46,31 +61,49 @@ class AgentsCompletionRequestTypedDict(TypedDict):
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
     response_format: NotRequired[ResponseFormatTypedDict]
     tools: NotRequired[Nullable[List[ToolTypedDict]]]
-    tool_choice: NotRequired[AgentsCompletionRequestToolChoice]
-    
+    tool_choice: NotRequired[AgentsCompletionRequestToolChoiceTypedDict]
+
 
 class AgentsCompletionRequest(BaseModel):
     messages: List[AgentsCompletionRequestMessages]
     r"""The prompt(s) to generate completions for, encoded as a list of dict with role and content."""
+
     agent_id: str
     r"""The ID of the agent to use for this completion."""
+
     max_tokens: OptionalNullable[int] = UNSET
     r"""The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length."""
+
     min_tokens: OptionalNullable[int] = UNSET
     r"""The minimum number of tokens to generate in the completion."""
+
     stream: Optional[bool] = False
     r"""Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON."""
+
     stop: Optional[AgentsCompletionRequestStop] = None
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
+
     random_seed: OptionalNullable[int] = UNSET
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
+
     response_format: Optional[ResponseFormat] = None
+
     tools: OptionalNullable[List[Tool]] = UNSET
-    tool_choice: Optional[AgentsCompletionRequestToolChoice] = "auto"
-    
+
+    tool_choice: Optional[AgentsCompletionRequestToolChoice] = None
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["max_tokens", "min_tokens", "stream", "stop", "random_seed", "response_format", "tools", "tool_choice"]
+        optional_fields = [
+            "max_tokens",
+            "min_tokens",
+            "stream",
+            "stop",
+            "random_seed",
+            "response_format",
+            "tools",
+            "tool_choice",
+        ]
         nullable_fields = ["max_tokens", "min_tokens", "random_seed", "tools"]
         null_default_fields = []
 
@@ -81,9 +114,13 @@ class AgentsCompletionRequest(BaseModel):
         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
+            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
@@ -93,4 +130,3 @@ class AgentsCompletionRequest(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/agentscompletionstreamrequest.py

@@ -4,12 +4,14 @@ from __future__ import annotations
 from .assistantmessage import AssistantMessage, AssistantMessageTypedDict
 from .responseformat import ResponseFormat, ResponseFormatTypedDict
 from .tool import Tool, ToolTypedDict
+from .toolchoice import ToolChoice, ToolChoiceTypedDict
+from .toolchoiceenum import ToolChoiceEnum
 from .toolmessage import ToolMessage, ToolMessageTypedDict
 from .usermessage import UserMessage, UserMessageTypedDict
 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, TypedDict, Union
+from typing import List, Optional, TypedDict, Union
 from typing_extensions import Annotated, NotRequired
 
 
@@ -21,13 +23,28 @@ AgentsCompletionStreamRequestStop = Union[str, List[str]]
 r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
 
 
-AgentsCompletionStreamRequestMessagesTypedDict = Union[UserMessageTypedDict, AssistantMessageTypedDict, ToolMessageTypedDict]
+AgentsCompletionStreamRequestMessagesTypedDict = Union[
+    UserMessageTypedDict, AssistantMessageTypedDict, ToolMessageTypedDict
+]
 
 
-AgentsCompletionStreamRequestMessages = Annotated[Union[Annotated[AssistantMessage, Tag("assistant")], Annotated[ToolMessage, Tag("tool")], Annotated[UserMessage, Tag("user")]], Discriminator(lambda m: get_discriminator(m, "role", "role"))]
+AgentsCompletionStreamRequestMessages = Annotated[
+    Union[
+        Annotated[AssistantMessage, Tag("assistant")],
+        Annotated[ToolMessage, Tag("tool")],
+        Annotated[UserMessage, Tag("user")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "role", "role")),
+]
 
 
-AgentsCompletionStreamRequestToolChoice = Literal["auto", "none", "any"]
+AgentsCompletionStreamRequestToolChoiceTypedDict = Union[
+    ToolChoiceTypedDict, ToolChoiceEnum
+]
+
+
+AgentsCompletionStreamRequestToolChoice = Union[ToolChoice, ToolChoiceEnum]
+
 
 class AgentsCompletionStreamRequestTypedDict(TypedDict):
     messages: List[AgentsCompletionStreamRequestMessagesTypedDict]
@@ -45,30 +62,48 @@ class AgentsCompletionStreamRequestTypedDict(TypedDict):
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
     response_format: NotRequired[ResponseFormatTypedDict]
     tools: NotRequired[Nullable[List[ToolTypedDict]]]
-    tool_choice: NotRequired[AgentsCompletionStreamRequestToolChoice]
-    
+    tool_choice: NotRequired[AgentsCompletionStreamRequestToolChoiceTypedDict]
+
 
 class AgentsCompletionStreamRequest(BaseModel):
     messages: List[AgentsCompletionStreamRequestMessages]
     r"""The prompt(s) to generate completions for, encoded as a list of dict with role and content."""
+
     agent_id: str
     r"""The ID of the agent to use for this completion."""
+
     max_tokens: OptionalNullable[int] = UNSET
     r"""The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length."""
+
     min_tokens: OptionalNullable[int] = UNSET
     r"""The minimum number of tokens to generate in the completion."""
+
     stream: Optional[bool] = True
+
     stop: Optional[AgentsCompletionStreamRequestStop] = None
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
+
     random_seed: OptionalNullable[int] = UNSET
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
+
     response_format: Optional[ResponseFormat] = None
+
     tools: OptionalNullable[List[Tool]] = UNSET
-    tool_choice: Optional[AgentsCompletionStreamRequestToolChoice] = "auto"
-    
+
+    tool_choice: Optional[AgentsCompletionStreamRequestToolChoice] = None
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["max_tokens", "min_tokens", "stream", "stop", "random_seed", "response_format", "tools", "tool_choice"]
+        optional_fields = [
+            "max_tokens",
+            "min_tokens",
+            "stream",
+            "stop",
+            "random_seed",
+            "response_format",
+            "tools",
+            "tool_choice",
+        ]
         nullable_fields = ["max_tokens", "min_tokens", "random_seed", "tools"]
         null_default_fields = []
 
@@ -79,9 +114,13 @@ class AgentsCompletionStreamRequest(BaseModel):
         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
+            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
@@ -91,4 +130,3 @@ class AgentsCompletionStreamRequest(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/archiveftmodelout.py

@@ -9,13 +9,17 @@ from typing_extensions import Annotated, NotRequired
 
 ArchiveFTModelOutObject = Literal["model"]
 
+
 class ArchiveFTModelOutTypedDict(TypedDict):
     id: str
     archived: NotRequired[bool]
-    
+
 
 class ArchiveFTModelOut(BaseModel):
     id: str
+
+    # fmt: off
     OBJECT: Annotated[Final[Optional[ArchiveFTModelOutObject]], pydantic.Field(alias="object")] = "model" # type: ignore
+    # fmt: on
+
     archived: Optional[bool] = True
-    

mistralai/models/assistantmessage.py

@@ -10,21 +10,25 @@ from typing_extensions import NotRequired
 
 AssistantMessageRole = Literal["assistant"]
 
+
 class AssistantMessageTypedDict(TypedDict):
     content: NotRequired[Nullable[str]]
     tool_calls: NotRequired[Nullable[List[ToolCallTypedDict]]]
     prefix: NotRequired[bool]
     r"""Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message."""
     role: NotRequired[AssistantMessageRole]
-    
+
 
 class AssistantMessage(BaseModel):
     content: OptionalNullable[str] = UNSET
+
     tool_calls: OptionalNullable[List[ToolCall]] = UNSET
+
     prefix: Optional[bool] = False
     r"""Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message."""
+
     role: Optional[AssistantMessageRole] = "assistant"
-    
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = ["content", "tool_calls", "prefix", "role"]
@@ -38,9 +42,13 @@ class AssistantMessage(BaseModel):
         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
+            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
@@ -50,4 +58,3 @@ class AssistantMessage(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/{modelcard.py → basemodelcard.py}

@@ -4,44 +4,64 @@ from __future__ import annotations
 from .modelcapabilities import ModelCapabilities, ModelCapabilitiesTypedDict
 from datetime import datetime
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+import pydantic
 from pydantic import model_serializer
-from typing import List, Optional, TypedDict
-from typing_extensions import NotRequired
+from typing import Final, List, Optional, TypedDict
+from typing_extensions import Annotated, NotRequired
 
 
-class ModelCardTypedDict(TypedDict):
+class BaseModelCardTypedDict(TypedDict):
     id: str
     capabilities: ModelCapabilitiesTypedDict
     object: NotRequired[str]
     created: NotRequired[int]
     owned_by: NotRequired[str]
-    root: NotRequired[Nullable[str]]
-    archived: NotRequired[bool]
     name: NotRequired[Nullable[str]]
     description: NotRequired[Nullable[str]]
     max_context_length: NotRequired[int]
     aliases: NotRequired[List[str]]
     deprecation: NotRequired[Nullable[datetime]]
-    
 
-class ModelCard(BaseModel):
+
+class BaseModelCard(BaseModel):
     id: str
+
     capabilities: ModelCapabilities
+
     object: Optional[str] = "model"
+
     created: Optional[int] = None
+
     owned_by: Optional[str] = "mistralai"
-    root: OptionalNullable[str] = UNSET
-    archived: Optional[bool] = False
+
     name: OptionalNullable[str] = UNSET
+
     description: OptionalNullable[str] = UNSET
+
     max_context_length: Optional[int] = 32768
+
     aliases: Optional[List[str]] = None
+
     deprecation: OptionalNullable[datetime] = UNSET
-    
+
+    # fmt: off
+    TYPE: Annotated[Final[Optional[str]], pydantic.Field(alias="type")] = "base" # type: ignore
+    # fmt: on
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["object", "created", "owned_by", "root", "archived", "name", "description", "max_context_length", "aliases", "deprecation"]
-        nullable_fields = ["root", "name", "description", "deprecation"]
+        optional_fields = [
+            "object",
+            "created",
+            "owned_by",
+            "name",
+            "description",
+            "max_context_length",
+            "aliases",
+            "deprecation",
+            "type",
+        ]
+        nullable_fields = ["name", "description", "deprecation"]
         null_default_fields = []
 
         serialized = handler(self)
@@ -51,9 +71,13 @@ class ModelCard(BaseModel):
         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
+            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
@@ -63,4 +87,3 @@ class ModelCard(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/chatcompletionchoice.py

@@ -8,14 +8,16 @@ from typing import Literal, TypedDict
 
 FinishReason = Literal["stop", "length", "model_length", "error", "tool_calls"]
 
+
 class ChatCompletionChoiceTypedDict(TypedDict):
     index: int
     message: AssistantMessageTypedDict
     finish_reason: FinishReason
-    
+
 
 class ChatCompletionChoice(BaseModel):
     index: int
+
     message: AssistantMessage
+
     finish_reason: FinishReason
-    

mistralai/models/chatcompletionrequest.py

@@ -5,12 +5,14 @@ from .assistantmessage import AssistantMessage, AssistantMessageTypedDict
 from .responseformat import ResponseFormat, ResponseFormatTypedDict
 from .systemmessage import SystemMessage, SystemMessageTypedDict
 from .tool import Tool, ToolTypedDict
+from .toolchoice import ToolChoice, ToolChoiceTypedDict
+from .toolchoiceenum import ToolChoiceEnum
 from .toolmessage import ToolMessage, ToolMessageTypedDict
 from .usermessage import UserMessage, UserMessageTypedDict
 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, TypedDict, Union
+from typing import List, Optional, TypedDict, Union
 from typing_extensions import Annotated, NotRequired
 
 
@@ -22,13 +24,30 @@ Stop = Union[str, List[str]]
 r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
 
 
-MessagesTypedDict = Union[SystemMessageTypedDict, UserMessageTypedDict, AssistantMessageTypedDict, ToolMessageTypedDict]
+MessagesTypedDict = Union[
+    SystemMessageTypedDict,
+    UserMessageTypedDict,
+    AssistantMessageTypedDict,
+    ToolMessageTypedDict,
+]
 
 
-Messages = 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"))]
+Messages = 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")),
+]
 
 
-ToolChoice = Literal["auto", "none", "any"]
+ChatCompletionRequestToolChoiceTypedDict = Union[ToolChoiceTypedDict, ToolChoiceEnum]
+
+
+ChatCompletionRequestToolChoice = Union[ToolChoice, ToolChoiceEnum]
+
 
 class ChatCompletionRequestTypedDict(TypedDict):
     model: Nullable[str]
@@ -51,39 +70,63 @@ class ChatCompletionRequestTypedDict(TypedDict):
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
     response_format: NotRequired[ResponseFormatTypedDict]
     tools: NotRequired[Nullable[List[ToolTypedDict]]]
-    tool_choice: NotRequired[ToolChoice]
+    tool_choice: NotRequired[ChatCompletionRequestToolChoiceTypedDict]
     safe_prompt: NotRequired[bool]
     r"""Whether to inject a safety prompt before all conversations."""
-    
+
 
 class ChatCompletionRequest(BaseModel):
     model: Nullable[str]
     r"""ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions."""
+
     messages: List[Messages]
     r"""The prompt(s) to generate completions for, encoded as a list of dict with role and content."""
+
     temperature: Optional[float] = 0.7
     r"""What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both."""
+
     top_p: Optional[float] = 1
     r"""Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both."""
+
     max_tokens: OptionalNullable[int] = UNSET
     r"""The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length."""
+
     min_tokens: OptionalNullable[int] = UNSET
     r"""The minimum number of tokens to generate in the completion."""
+
     stream: Optional[bool] = False
     r"""Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON."""
+
     stop: Optional[Stop] = None
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
+
     random_seed: OptionalNullable[int] = UNSET
     r"""The seed to use for random sampling. If set, different calls will generate deterministic results."""
+
     response_format: Optional[ResponseFormat] = None
+
     tools: OptionalNullable[List[Tool]] = UNSET
-    tool_choice: Optional[ToolChoice] = "auto"
+
+    tool_choice: Optional[ChatCompletionRequestToolChoice] = None
+
     safe_prompt: Optional[bool] = False
     r"""Whether to inject a safety prompt before all conversations."""
-    
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["temperature", "top_p", "max_tokens", "min_tokens", "stream", "stop", "random_seed", "response_format", "tools", "tool_choice", "safe_prompt"]
+        optional_fields = [
+            "temperature",
+            "top_p",
+            "max_tokens",
+            "min_tokens",
+            "stream",
+            "stop",
+            "random_seed",
+            "response_format",
+            "tools",
+            "tool_choice",
+            "safe_prompt",
+        ]
         nullable_fields = ["model", "max_tokens", "min_tokens", "random_seed", "tools"]
         null_default_fields = []
 
@@ -94,9 +137,13 @@ class ChatCompletionRequest(BaseModel):
         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
+            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
@@ -106,4 +153,3 @@ class ChatCompletionRequest(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/chatcompletionresponse.py

@@ -15,13 +15,17 @@ class ChatCompletionResponseTypedDict(TypedDict):
     usage: UsageInfoTypedDict
     created: NotRequired[int]
     choices: NotRequired[List[ChatCompletionChoiceTypedDict]]
-    
+
 
 class ChatCompletionResponse(BaseModel):
     id: str
+
     object: str
+
     model: str
+
     usage: UsageInfo
+
     created: Optional[int] = None
+
     choices: Optional[List[ChatCompletionChoice]] = None
-