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

mistralai/models/agent.py

@@ -12,7 +12,7 @@ from datetime import datetime
 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,8 +50,11 @@ class AgentTypedDict(TypedDict):
     name: str
     id: str
     version: int
+    versions: List[int]
     created_at: datetime
     updated_at: datetime
+    deployment_chat: bool
+    source: str
     instructions: NotRequired[Nullable[str]]
     r"""Instruction prompt the model will follow during the conversation."""
     tools: NotRequired[List[AgentToolsTypedDict]]
@@ -60,6 +63,7 @@ class AgentTypedDict(TypedDict):
     r"""White-listed arguments from the completion API"""
     description: NotRequired[Nullable[str]]
     handoffs: NotRequired[Nullable[List[str]]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
     object: NotRequired[AgentObject]
 
 
@@ -72,10 +76,16 @@ class Agent(BaseModel):
 
     version: int
 
+    versions: List[int]
+
     created_at: datetime
 
     updated_at: datetime
 
+    deployment_chat: bool
+
+    source: str
+
     instructions: OptionalNullable[str] = UNSET
     r"""Instruction prompt the model will follow during the conversation."""
 
@@ -89,6 +99,8 @@ class Agent(BaseModel):
 
     handoffs: OptionalNullable[List[str]] = UNSET
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     object: Optional[AgentObject] = "agent"
 
     @model_serializer(mode="wrap")
@@ -99,9 +111,10 @@ class Agent(BaseModel):
             "completion_args",
             "description",
             "handoffs",
+            "metadata",
             "object",
         ]
-        nullable_fields = ["instructions", "description", "handoffs"]
+        nullable_fields = ["instructions", "description", "handoffs", "metadata"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/agentconversation.py

@@ -4,7 +4,7 @@ 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 Literal, Optional
+from typing import Any, Dict, Literal, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
@@ -20,7 +20,10 @@ class AgentConversationTypedDict(TypedDict):
     r"""Name given to the conversation."""
     description: NotRequired[Nullable[str]]
     r"""Description of the what the conversation is about."""
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
+    r"""Custom metadata for the conversation."""
     object: NotRequired[AgentConversationObject]
+    agent_version: NotRequired[Nullable[int]]
 
 
 class AgentConversation(BaseModel):
@@ -38,12 +41,17 @@ class AgentConversation(BaseModel):
     description: OptionalNullable[str] = UNSET
     r"""Description of the what the conversation is about."""
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+    r"""Custom metadata for the conversation."""
+
     object: Optional[AgentConversationObject] = "conversation"
 
+    agent_version: OptionalNullable[int] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["name", "description", "object"]
-        nullable_fields = ["name", "description"]
+        optional_fields = ["name", "description", "metadata", "object", "agent_version"]
+        nullable_fields = ["name", "description", "metadata", "agent_version"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/agentcreationrequest.py

@@ -11,7 +11,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, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -52,6 +52,7 @@ class AgentCreationRequestTypedDict(TypedDict):
     r"""White-listed arguments from the completion API"""
     description: NotRequired[Nullable[str]]
     handoffs: NotRequired[Nullable[List[str]]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class AgentCreationRequest(BaseModel):
@@ -72,6 +73,8 @@ class AgentCreationRequest(BaseModel):
 
     handoffs: OptionalNullable[List[str]] = UNSET
 
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -80,8 +83,9 @@ class AgentCreationRequest(BaseModel):
             "completion_args",
             "description",
             "handoffs",
+            "metadata",
         ]
-        nullable_fields = ["instructions", "description", "handoffs"]
+        nullable_fields = ["instructions", "description", "handoffs", "metadata"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/agents_api_v1_agents_deleteop.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mistralai.types import BaseModel
+from mistralai.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class AgentsAPIV1AgentsDeleteRequestTypedDict(TypedDict):
+    agent_id: str
+
+
+class AgentsAPIV1AgentsDeleteRequest(BaseModel):
+    agent_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

mistralai/models/agents_api_v1_agents_getop.py

@@ -1,16 +1,53 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from mistralai.types import BaseModel
-from mistralai.utils import FieldMetadata, PathParamMetadata
-from typing_extensions import Annotated, TypedDict
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from mistralai.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class AgentsAPIV1AgentsGetRequestTypedDict(TypedDict):
     agent_id: str
+    agent_version: NotRequired[Nullable[int]]
 
 
 class AgentsAPIV1AgentsGetRequest(BaseModel):
     agent_id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
+
+    agent_version: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["agent_version"]
+        nullable_fields = ["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/agents_api_v1_agents_listop.py

@@ -1,15 +1,22 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from mistralai.types import BaseModel
+from .requestsource import RequestSource
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mistralai.utils import FieldMetadata, QueryParamMetadata
-from typing import Optional
+from pydantic import model_serializer
+from typing import Any, Dict, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class AgentsAPIV1AgentsListRequestTypedDict(TypedDict):
     page: NotRequired[int]
     page_size: NotRequired[int]
+    deployment_chat: NotRequired[Nullable[bool]]
+    sources: NotRequired[Nullable[List[RequestSource]]]
+    name: NotRequired[Nullable[str]]
+    id: NotRequired[Nullable[str]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class AgentsAPIV1AgentsListRequest(BaseModel):
@@ -22,3 +29,66 @@ class AgentsAPIV1AgentsListRequest(BaseModel):
         Optional[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = 20
+
+    deployment_chat: Annotated[
+        OptionalNullable[bool],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    sources: Annotated[
+        OptionalNullable[List[RequestSource]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    name: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    id: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    metadata: Annotated[
+        OptionalNullable[Dict[str, Any]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "page",
+            "page_size",
+            "deployment_chat",
+            "sources",
+            "name",
+            "id",
+            "metadata",
+        ]
+        nullable_fields = ["deployment_chat", "sources", "name", "id", "metadata"]
+        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/agents_api_v1_conversations_deleteop.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from mistralai.types import BaseModel
+from mistralai.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class AgentsAPIV1ConversationsDeleteRequestTypedDict(TypedDict):
+    conversation_id: str
+    r"""ID of the conversation from which we are fetching metadata."""
+
+
+class AgentsAPIV1ConversationsDeleteRequest(BaseModel):
+    conversation_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""ID of the conversation from which we are fetching metadata."""

mistralai/models/agents_api_v1_conversations_listop.py

@@ -3,15 +3,17 @@
 from __future__ import annotations
 from .agentconversation import AgentConversation, AgentConversationTypedDict
 from .modelconversation import ModelConversation, ModelConversationTypedDict
-from mistralai.types import BaseModel
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from mistralai.utils import FieldMetadata, QueryParamMetadata
-from typing import Optional, Union
+from pydantic import model_serializer
+from typing import Any, Dict, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 class AgentsAPIV1ConversationsListRequestTypedDict(TypedDict):
     page: NotRequired[int]
     page_size: NotRequired[int]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class AgentsAPIV1ConversationsListRequest(BaseModel):
@@ -25,6 +27,41 @@ class AgentsAPIV1ConversationsListRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = 100
 
+    metadata: Annotated[
+        OptionalNullable[Dict[str, Any]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["page", "page_size", "metadata"]
+        nullable_fields = ["metadata"]
+        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
+
 
 ResponseBodyTypedDict = TypeAliasType(
     "ResponseBodyTypedDict",

mistralai/models/agentscompletionrequest.py

@@ -15,7 +15,7 @@ from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_
 from mistralai.utils import get_discriminator, validate_open_enum
 from pydantic import Discriminator, Tag, model_serializer
 from pydantic.functional_validators import PlainValidator
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -77,16 +77,19 @@ class AgentsCompletionRequestTypedDict(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]]]
     response_format: NotRequired[ResponseFormatTypedDict]
+    r"""Specify the format that the model must output. By default it will use `{ \"type\": \"text\" }`. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ \"type\": \"json_schema\" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide."""
     tools: NotRequired[Nullable[List[ToolTypedDict]]]
     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."""
+    r"""The `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."""
+    r"""The `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."""
     prediction: NotRequired[PredictionTypedDict]
+    r"""Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content."""
     parallel_tool_calls: NotRequired[bool]
     prompt_mode: NotRequired[Nullable[MistralPromptMode]]
     r"""Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used."""
@@ -111,22 +114,26 @@ class AgentsCompletionRequest(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
+
     response_format: Optional[ResponseFormat] = None
+    r"""Specify the format that the model must output. By default it will use `{ \"type\": \"text\" }`. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ \"type\": \"json_schema\" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide."""
 
     tools: OptionalNullable[List[Tool]] = UNSET
 
     tool_choice: Optional[AgentsCompletionRequestToolChoice] = None
 
     presence_penalty: Optional[float] = None
-    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."""
+    r"""The `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] = None
-    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."""
+    r"""The `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."""
 
     prediction: Optional[Prediction] = None
+    r"""Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content."""
 
     parallel_tool_calls: Optional[bool] = None
 
@@ -142,6 +149,7 @@ class AgentsCompletionRequest(BaseModel):
             "stream",
             "stop",
             "random_seed",
+            "metadata",
             "response_format",
             "tools",
             "tool_choice",
@@ -152,7 +160,14 @@ class AgentsCompletionRequest(BaseModel):
             "parallel_tool_calls",
             "prompt_mode",
         ]
-        nullable_fields = ["max_tokens", "random_seed", "tools", "n", "prompt_mode"]
+        nullable_fields = [
+            "max_tokens",
+            "random_seed",
+            "metadata",
+            "tools",
+            "n",
+            "prompt_mode",
+        ]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/agentscompletionstreamrequest.py

@@ -15,7 +15,7 @@ from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_
 from mistralai.utils import get_discriminator, validate_open_enum
 from pydantic import Discriminator, Tag, model_serializer
 from pydantic.functional_validators import PlainValidator
-from typing import List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -76,16 +76,19 @@ class AgentsCompletionStreamRequestTypedDict(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]]]
     response_format: NotRequired[ResponseFormatTypedDict]
+    r"""Specify the format that the model must output. By default it will use `{ \"type\": \"text\" }`. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ \"type\": \"json_schema\" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide."""
     tools: NotRequired[Nullable[List[ToolTypedDict]]]
     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."""
+    r"""The `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."""
+    r"""The `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."""
     prediction: NotRequired[PredictionTypedDict]
+    r"""Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content."""
     parallel_tool_calls: NotRequired[bool]
     prompt_mode: NotRequired[Nullable[MistralPromptMode]]
     r"""Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used."""
@@ -109,22 +112,26 @@ class AgentsCompletionStreamRequest(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
+
     response_format: Optional[ResponseFormat] = None
+    r"""Specify the format that the model must output. By default it will use `{ \"type\": \"text\" }`. Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ \"type\": \"json_schema\" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide."""
 
     tools: OptionalNullable[List[Tool]] = UNSET
 
     tool_choice: Optional[AgentsCompletionStreamRequestToolChoice] = None
 
     presence_penalty: Optional[float] = None
-    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."""
+    r"""The `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] = None
-    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."""
+    r"""The `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."""
 
     prediction: Optional[Prediction] = None
+    r"""Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content."""
 
     parallel_tool_calls: Optional[bool] = None
 
@@ -140,6 +147,7 @@ class AgentsCompletionStreamRequest(BaseModel):
             "stream",
             "stop",
             "random_seed",
+            "metadata",
             "response_format",
             "tools",
             "tool_choice",
@@ -150,7 +158,14 @@ class AgentsCompletionStreamRequest(BaseModel):
             "parallel_tool_calls",
             "prompt_mode",
         ]
-        nullable_fields = ["max_tokens", "random_seed", "tools", "n", "prompt_mode"]
+        nullable_fields = [
+            "max_tokens",
+            "random_seed",
+            "metadata",
+            "tools",
+            "n",
+            "prompt_mode",
+        ]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/agentupdaterequest.py

@@ -11,7 +11,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, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -52,6 +52,8 @@ class AgentUpdateRequestTypedDict(TypedDict):
     name: NotRequired[Nullable[str]]
     description: NotRequired[Nullable[str]]
     handoffs: NotRequired[Nullable[List[str]]]
+    deployment_chat: NotRequired[Nullable[bool]]
+    metadata: NotRequired[Nullable[Dict[str, Any]]]
 
 
 class AgentUpdateRequest(BaseModel):
@@ -72,6 +74,10 @@ class AgentUpdateRequest(BaseModel):
 
     handoffs: OptionalNullable[List[str]] = UNSET
 
+    deployment_chat: OptionalNullable[bool] = UNSET
+
+    metadata: OptionalNullable[Dict[str, Any]] = UNSET
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
@@ -82,8 +88,18 @@ class AgentUpdateRequest(BaseModel):
             "name",
             "description",
             "handoffs",
+            "deployment_chat",
+            "metadata",
+        ]
+        nullable_fields = [
+            "instructions",
+            "model",
+            "name",
+            "description",
+            "handoffs",
+            "deployment_chat",
+            "metadata",
         ]
-        nullable_fields = ["instructions", "model", "name", "description", "handoffs"]
         null_default_fields = []
 
         serialized = handler(self)

mistralai/models/audiotranscriptionrequest.py

@@ -14,6 +14,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class AudioTranscriptionRequestTypedDict(TypedDict):
     model: str
+    r"""ID of the model to be used."""
     file: NotRequired[FileTypedDict]
     file_url: NotRequired[Nullable[str]]
     r"""Url of a file to be transcribed"""
@@ -29,6 +30,7 @@ class AudioTranscriptionRequestTypedDict(TypedDict):
 
 class AudioTranscriptionRequest(BaseModel):
     model: Annotated[str, FieldMetadata(multipart=True)]
+    r"""ID of the model to be used."""
 
     file: Annotated[
         Optional[File], FieldMetadata(multipart=MultipartFormMetadata(file=True))

mistralai/models/batchjobin.py

@@ -12,25 +12,35 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 
 class BatchJobInTypedDict(TypedDict):
     input_files: List[str]
+    r"""The list of input files to be used for batch inference, these files should be `jsonl` files, containing the input data corresponding to the bory request for the batch inference in a \"body\" field. An example of such file is the following: ```json {\"custom_id\": \"0\", \"body\": {\"max_tokens\": 100, \"messages\": [{\"role\": \"user\", \"content\": \"What is the best French cheese?\"}]}} {\"custom_id\": \"1\", \"body\": {\"max_tokens\": 100, \"messages\": [{\"role\": \"user\", \"content\": \"What is the best French wine?\"}]}} ```"""
     endpoint: APIEndpoint
     model: NotRequired[Nullable[str]]
+    r"""The model to be used for batch inference."""
     agent_id: NotRequired[Nullable[str]]
+    r"""In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here."""
     metadata: NotRequired[Nullable[Dict[str, str]]]
+    r"""The metadata of your choice to be associated with the batch inference job."""
     timeout_hours: NotRequired[int]
+    r"""The timeout in hours for the batch inference job."""
 
 
 class BatchJobIn(BaseModel):
     input_files: List[str]
+    r"""The list of input files to be used for batch inference, these files should be `jsonl` files, containing the input data corresponding to the bory request for the batch inference in a \"body\" field. An example of such file is the following: ```json {\"custom_id\": \"0\", \"body\": {\"max_tokens\": 100, \"messages\": [{\"role\": \"user\", \"content\": \"What is the best French cheese?\"}]}} {\"custom_id\": \"1\", \"body\": {\"max_tokens\": 100, \"messages\": [{\"role\": \"user\", \"content\": \"What is the best French wine?\"}]}} ```"""
 
     endpoint: Annotated[APIEndpoint, PlainValidator(validate_open_enum(False))]
 
     model: OptionalNullable[str] = UNSET
+    r"""The model to be used for batch inference."""
 
     agent_id: OptionalNullable[str] = UNSET
+    r"""In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here."""
 
     metadata: OptionalNullable[Dict[str, str]] = UNSET
+    r"""The metadata of your choice to be associated with the batch inference job."""
 
     timeout_hours: Optional[int] = 24
+    r"""The timeout in hours for the batch inference job."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):