mistralai 1.0.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

mistralai/models/agentscompletionrequest.py

@@ -3,14 +3,17 @@
 from __future__ import annotations
 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_extensions import Annotated, NotRequired
+from typing import List, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 AgentsCompletionRequestStopTypedDict = Union[str, List[str]]
@@ -21,13 +24,30 @@ 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[
+    SystemMessageTypedDict,
+    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[SystemMessage, Tag("system")],
+        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]
@@ -36,8 +56,6 @@ class AgentsCompletionRequestTypedDict(TypedDict):
     r"""The ID of the agent to use for this completion."""
     max_tokens: NotRequired[Nullable[int]]
     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: NotRequired[Nullable[int]]
-    r"""The minimum number of tokens to generate in the completion."""
     stream: NotRequired[bool]
     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: NotRequired[AgentsCompletionRequestStopTypedDict]
@@ -46,32 +64,64 @@ 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]
+    presence_penalty: NotRequired[float]
+    r"""presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative."""
+    frequency_penalty: NotRequired[float]
+    r"""frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition."""
+    n: NotRequired[Nullable[int]]
+    r"""Number of completions to return for each request, input tokens are only billed once."""
+
 
 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
+
+    presence_penalty: Optional[float] = 0
+    r"""presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative."""
+
+    frequency_penalty: Optional[float] = 0
+    r"""frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition."""
+
+    n: OptionalNullable[int] = UNSET
+    r"""Number of completions to return for each request, input tokens are only billed once."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["max_tokens", "min_tokens", "stream", "stop", "random_seed", "response_format", "tools", "tool_choice"]
-        nullable_fields = ["max_tokens", "min_tokens", "random_seed", "tools"]
+        optional_fields = [
+            "max_tokens",
+            "stream",
+            "stop",
+            "random_seed",
+            "response_format",
+            "tools",
+            "tool_choice",
+            "presence_penalty",
+            "frequency_penalty",
+            "n",
+        ]
+        nullable_fields = ["max_tokens", "random_seed", "tools", "n"]
         null_default_fields = []
 
         serialized = handler(self)
@@ -81,9 +131,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 +147,3 @@ class AgentsCompletionRequest(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/agentscompletionstreamrequest.py

@@ -3,14 +3,17 @@
 from __future__ import annotations
 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_extensions import Annotated, NotRequired
+from typing import List, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 AgentsCompletionStreamRequestStopTypedDict = Union[str, List[str]]
@@ -21,13 +24,32 @@ 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[
+    SystemMessageTypedDict,
+    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[SystemMessage, Tag("system")],
+        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]
@@ -36,8 +58,6 @@ class AgentsCompletionStreamRequestTypedDict(TypedDict):
     r"""The ID of the agent to use for this completion."""
     max_tokens: NotRequired[Nullable[int]]
     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: NotRequired[Nullable[int]]
-    r"""The minimum number of tokens to generate in the completion."""
     stream: NotRequired[bool]
     stop: NotRequired[AgentsCompletionStreamRequestStopTypedDict]
     r"""Stop generation if this token is detected. Or if one of these tokens is detected when providing an array"""
@@ -45,31 +65,63 @@ 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]
+    presence_penalty: NotRequired[float]
+    r"""presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative."""
+    frequency_penalty: NotRequired[float]
+    r"""frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition."""
+    n: NotRequired[Nullable[int]]
+    r"""Number of completions to return for each request, input tokens are only billed once."""
+
 
 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
+
+    presence_penalty: Optional[float] = 0
+    r"""presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative."""
+
+    frequency_penalty: Optional[float] = 0
+    r"""frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition."""
+
+    n: OptionalNullable[int] = UNSET
+    r"""Number of completions to return for each request, input tokens are only billed once."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["max_tokens", "min_tokens", "stream", "stop", "random_seed", "response_format", "tools", "tool_choice"]
-        nullable_fields = ["max_tokens", "min_tokens", "random_seed", "tools"]
+        optional_fields = [
+            "max_tokens",
+            "stream",
+            "stop",
+            "random_seed",
+            "response_format",
+            "tools",
+            "tool_choice",
+            "presence_penalty",
+            "frequency_penalty",
+            "n",
+        ]
+        nullable_fields = ["max_tokens", "random_seed", "tools", "n"]
         null_default_fields = []
 
         serialized = handler(self)
@@ -79,9 +131,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 +147,3 @@ class AgentsCompletionStreamRequest(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/apiendpoint.py

@@ -0,0 +1,9 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+APIEndpoint = Literal[
+    "/v1/chat/completions", "/v1/embeddings", "/v1/fim/completions", "/v1/moderations"
+]

mistralai/models/archiveftmodelout.py

@@ -2,20 +2,30 @@
 
 from __future__ import annotations
 from mistralai.types import BaseModel
+from mistralai.utils import validate_const
 import pydantic
-from typing import Final, Literal, Optional, TypedDict
-from typing_extensions import Annotated, NotRequired
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 ArchiveFTModelOutObject = Literal["model"]
 
+
 class ArchiveFTModelOutTypedDict(TypedDict):
     id: str
+    object: ArchiveFTModelOutObject
     archived: NotRequired[bool]
-    
+
 
 class ArchiveFTModelOut(BaseModel):
     id: str
-    OBJECT: Annotated[Final[Optional[ArchiveFTModelOutObject]], pydantic.Field(alias="object")] = "model" # type: ignore
+
+    OBJECT: Annotated[
+        Annotated[
+            Optional[ArchiveFTModelOutObject], AfterValidator(validate_const("model"))
+        ],
+        pydantic.Field(alias="object"),
+    ] = "model"
+
     archived: Optional[bool] = True
-    

mistralai/models/assistantmessage.py

@@ -1,30 +1,39 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .contentchunk import ContentChunk, ContentChunkTypedDict
 from .toolcall import ToolCall, ToolCallTypedDict
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
-from typing import List, Literal, Optional, TypedDict
-from typing_extensions import NotRequired
+from typing import List, Literal, Optional, Union
+from typing_extensions import NotRequired, TypedDict
+
+
+AssistantMessageContentTypedDict = Union[str, List[ContentChunkTypedDict]]
+
+
+AssistantMessageContent = Union[str, List[ContentChunk]]
 
 
 AssistantMessageRole = Literal["assistant"]
 
+
 class AssistantMessageTypedDict(TypedDict):
-    content: NotRequired[Nullable[str]]
+    content: NotRequired[Nullable[AssistantMessageContentTypedDict]]
     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
+    content: OptionalNullable[AssistantMessageContent] = 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 +47,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 +63,3 @@ class AssistantMessage(BaseModel):
                 m[k] = val
 
         return m
-        

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

@@ -4,44 +4,80 @@ from __future__ import annotations
 from .modelcapabilities import ModelCapabilities, ModelCapabilitiesTypedDict
 from datetime import datetime
 from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mistralai.utils import validate_const
+import pydantic
 from pydantic import model_serializer
-from typing import List, Optional, TypedDict
-from typing_extensions import NotRequired
+from pydantic.functional_validators import AfterValidator
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class ModelCardTypedDict(TypedDict):
+Type = Literal["base"]
+
+
+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]]
-    
+    default_model_temperature: NotRequired[Nullable[float]]
+    type: Type
 
-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
-    
+
+    default_model_temperature: OptionalNullable[float] = UNSET
+
+    TYPE: Annotated[
+        Annotated[Optional[Type], AfterValidator(validate_const("base"))],
+        pydantic.Field(alias="type"),
+    ] = "base"
+
     @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",
+            "default_model_temperature",
+            "type",
+        ]
+        nullable_fields = [
+            "name",
+            "description",
+            "deprecation",
+            "default_model_temperature",
+        ]
         null_default_fields = []
 
         serialized = handler(self)
@@ -51,9 +87,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 +103,3 @@ class ModelCard(BaseModel):
                 m[k] = val
 
         return m
-        

mistralai/models/batcherror.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mistralai.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class BatchErrorTypedDict(TypedDict):
+    message: str
+    count: NotRequired[int]
+
+
+class BatchError(BaseModel):
+    message: str
+
+    count: Optional[int] = 1

mistralai/models/batchjobin.py

@@ -0,0 +1,58 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .apiendpoint import APIEndpoint
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Dict, List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class BatchJobInTypedDict(TypedDict):
+    input_files: List[str]
+    endpoint: APIEndpoint
+    model: str
+    metadata: NotRequired[Nullable[Dict[str, str]]]
+    timeout_hours: NotRequired[int]
+
+
+class BatchJobIn(BaseModel):
+    input_files: List[str]
+
+    endpoint: APIEndpoint
+
+    model: str
+
+    metadata: OptionalNullable[Dict[str, str]] = UNSET
+
+    timeout_hours: Optional[int] = 24
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["metadata", "timeout_hours"]
+        nullable_fields = ["metadata"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in self.model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m