mistralai 1.7.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

mistralai/models/outputcontentchunks.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .documenturlchunk import DocumentURLChunk, DocumentURLChunkTypedDict
+from .imageurlchunk import ImageURLChunk, ImageURLChunkTypedDict
+from .textchunk import TextChunk, TextChunkTypedDict
+from .toolfilechunk import ToolFileChunk, ToolFileChunkTypedDict
+from .toolreferencechunk import ToolReferenceChunk, ToolReferenceChunkTypedDict
+from typing import Union
+from typing_extensions import TypeAliasType
+
+
+OutputContentChunksTypedDict = TypeAliasType(
+    "OutputContentChunksTypedDict",
+    Union[
+        TextChunkTypedDict,
+        ImageURLChunkTypedDict,
+        DocumentURLChunkTypedDict,
+        ToolFileChunkTypedDict,
+        ToolReferenceChunkTypedDict,
+    ],
+)
+
+
+OutputContentChunks = TypeAliasType(
+    "OutputContentChunks",
+    Union[
+        TextChunk, ImageURLChunk, DocumentURLChunk, ToolFileChunk, ToolReferenceChunk
+    ],
+)

mistralai/models/responsedoneevent.py

@@ -0,0 +1,25 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .conversationusageinfo import ConversationUsageInfo, ConversationUsageInfoTypedDict
+from datetime import datetime
+from mistralai.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ResponseDoneEventType = Literal["conversation.response.done"]
+
+
+class ResponseDoneEventTypedDict(TypedDict):
+    usage: ConversationUsageInfoTypedDict
+    type: NotRequired[ResponseDoneEventType]
+    created_at: NotRequired[datetime]
+
+
+class ResponseDoneEvent(BaseModel):
+    usage: ConversationUsageInfo
+
+    type: Optional[ResponseDoneEventType] = "conversation.response.done"
+
+    created_at: Optional[datetime] = None

mistralai/models/responseerrorevent.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from mistralai.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ResponseErrorEventType = Literal["conversation.response.error"]
+
+
+class ResponseErrorEventTypedDict(TypedDict):
+    message: str
+    code: int
+    type: NotRequired[ResponseErrorEventType]
+    created_at: NotRequired[datetime]
+
+
+class ResponseErrorEvent(BaseModel):
+    message: str
+
+    code: int
+
+    type: Optional[ResponseErrorEventType] = "conversation.response.error"
+
+    created_at: Optional[datetime] = None

mistralai/models/responsestartedevent.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from mistralai.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ResponseStartedEventType = Literal["conversation.response.started"]
+
+
+class ResponseStartedEventTypedDict(TypedDict):
+    conversation_id: str
+    type: NotRequired[ResponseStartedEventType]
+    created_at: NotRequired[datetime]
+
+
+class ResponseStartedEvent(BaseModel):
+    conversation_id: str
+
+    type: Optional[ResponseStartedEventType] = "conversation.response.started"
+
+    created_at: Optional[datetime] = None

mistralai/models/ssetypes.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+SSETypes = Literal[
+    "conversation.response.started",
+    "conversation.response.done",
+    "conversation.response.error",
+    "message.output.delta",
+    "tool.execution.started",
+    "tool.execution.done",
+    "agent.handoff.started",
+    "agent.handoff.done",
+    "function.call.delta",
+]
+r"""Server side events sent when streaming a conversation response."""

mistralai/models/toolexecutiondoneevent.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .builtinconnectors import BuiltInConnectors
+from datetime import datetime
+from mistralai.types import BaseModel
+from typing import Any, Dict, Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ToolExecutionDoneEventType = Literal["tool.execution.done"]
+
+
+class ToolExecutionDoneEventTypedDict(TypedDict):
+    id: str
+    name: BuiltInConnectors
+    type: NotRequired[ToolExecutionDoneEventType]
+    created_at: NotRequired[datetime]
+    output_index: NotRequired[int]
+    info: NotRequired[Dict[str, Any]]
+
+
+class ToolExecutionDoneEvent(BaseModel):
+    id: str
+
+    name: BuiltInConnectors
+
+    type: Optional[ToolExecutionDoneEventType] = "tool.execution.done"
+
+    created_at: Optional[datetime] = None
+
+    output_index: Optional[int] = 0
+
+    info: Optional[Dict[str, Any]] = None

mistralai/models/toolexecutionentry.py

@@ -0,0 +1,70 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .builtinconnectors import BuiltInConnectors
+from datetime import datetime
+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
+
+
+ToolExecutionEntryObject = Literal["entry"]
+
+ToolExecutionEntryType = Literal["tool.execution"]
+
+
+class ToolExecutionEntryTypedDict(TypedDict):
+    name: BuiltInConnectors
+    object: NotRequired[ToolExecutionEntryObject]
+    type: NotRequired[ToolExecutionEntryType]
+    created_at: NotRequired[datetime]
+    completed_at: NotRequired[Nullable[datetime]]
+    id: NotRequired[str]
+    info: NotRequired[Dict[str, Any]]
+
+
+class ToolExecutionEntry(BaseModel):
+    name: BuiltInConnectors
+
+    object: Optional[ToolExecutionEntryObject] = "entry"
+
+    type: Optional[ToolExecutionEntryType] = "tool.execution"
+
+    created_at: Optional[datetime] = None
+
+    completed_at: OptionalNullable[datetime] = UNSET
+
+    id: Optional[str] = None
+
+    info: Optional[Dict[str, Any]] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["object", "type", "created_at", "completed_at", "id", "info"]
+        nullable_fields = ["completed_at"]
+        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

mistralai/models/toolexecutionstartedevent.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .builtinconnectors import BuiltInConnectors
+from datetime import datetime
+from mistralai.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ToolExecutionStartedEventType = Literal["tool.execution.started"]
+
+
+class ToolExecutionStartedEventTypedDict(TypedDict):
+    id: str
+    name: BuiltInConnectors
+    type: NotRequired[ToolExecutionStartedEventType]
+    created_at: NotRequired[datetime]
+    output_index: NotRequired[int]
+
+
+class ToolExecutionStartedEvent(BaseModel):
+    id: str
+
+    name: BuiltInConnectors
+
+    type: Optional[ToolExecutionStartedEventType] = "tool.execution.started"
+
+    created_at: Optional[datetime] = None
+
+    output_index: Optional[int] = 0

mistralai/models/toolfilechunk.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .builtinconnectors import BuiltInConnectors
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ToolFileChunkType = Literal["tool_file"]
+
+
+class ToolFileChunkTypedDict(TypedDict):
+    tool: BuiltInConnectors
+    file_id: str
+    type: NotRequired[ToolFileChunkType]
+    file_name: NotRequired[Nullable[str]]
+    file_type: NotRequired[Nullable[str]]
+
+
+class ToolFileChunk(BaseModel):
+    tool: BuiltInConnectors
+
+    file_id: str
+
+    type: Optional[ToolFileChunkType] = "tool_file"
+
+    file_name: OptionalNullable[str] = UNSET
+
+    file_type: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "file_name", "file_type"]
+        nullable_fields = ["file_name", "file_type"]
+        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

mistralai/models/toolreferencechunk.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .builtinconnectors import BuiltInConnectors
+from mistralai.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ToolReferenceChunkType = Literal["tool_reference"]
+
+
+class ToolReferenceChunkTypedDict(TypedDict):
+    tool: BuiltInConnectors
+    title: str
+    type: NotRequired[ToolReferenceChunkType]
+    url: NotRequired[Nullable[str]]
+    source: NotRequired[Nullable[str]]
+
+
+class ToolReferenceChunk(BaseModel):
+    tool: BuiltInConnectors
+
+    title: str
+
+    type: Optional[ToolReferenceChunkType] = "tool_reference"
+
+    url: OptionalNullable[str] = UNSET
+
+    source: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "url", "source"]
+        nullable_fields = ["url", "source"]
+        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

mistralai/models/websearchpremiumtool.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 Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+WebSearchPremiumToolType = Literal["web_search_premium"]
+
+
+class WebSearchPremiumToolTypedDict(TypedDict):
+    type: NotRequired[WebSearchPremiumToolType]
+
+
+class WebSearchPremiumTool(BaseModel):
+    type: Optional[WebSearchPremiumToolType] = "web_search_premium"

mistralai/models/websearchtool.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 Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+WebSearchToolType = Literal["web_search"]
+
+
+class WebSearchToolTypedDict(TypedDict):
+    type: NotRequired[WebSearchToolType]
+
+
+class WebSearchTool(BaseModel):
+    type: Optional[WebSearchToolType] = "web_search"

mistralai/ocr.py

@@ -21,6 +21,12 @@ class Ocr(BaseSDK):
         include_image_base64: OptionalNullable[bool] = UNSET,
         image_limit: OptionalNullable[int] = UNSET,
         image_min_size: OptionalNullable[int] = UNSET,
+        bbox_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
+        document_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -35,6 +41,8 @@ class Ocr(BaseSDK):
         :param include_image_base64: Include image URLs in response
         :param image_limit: Max images to extract
         :param image_min_size: Minimum height and width of image to extract
+        :param bbox_annotation_format: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
+        :param document_annotation_format: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -58,6 +66,12 @@ class Ocr(BaseSDK):
             include_image_base64=include_image_base64,
             image_limit=image_limit,
             image_min_size=image_min_size,
+            bbox_annotation_format=utils.get_pydantic_model(
+                bbox_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
+            document_annotation_format=utils.get_pydantic_model(
+                document_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
         )
 
         req = self._build_request(
@@ -139,6 +153,12 @@ class Ocr(BaseSDK):
         include_image_base64: OptionalNullable[bool] = UNSET,
         image_limit: OptionalNullable[int] = UNSET,
         image_min_size: OptionalNullable[int] = UNSET,
+        bbox_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
+        document_annotation_format: OptionalNullable[
+            Union[models.ResponseFormat, models.ResponseFormatTypedDict]
+        ] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -153,6 +173,8 @@ class Ocr(BaseSDK):
         :param include_image_base64: Include image URLs in response
         :param image_limit: Max images to extract
         :param image_min_size: Minimum height and width of image to extract
+        :param bbox_annotation_format: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
+        :param document_annotation_format: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -176,6 +198,12 @@ class Ocr(BaseSDK):
             include_image_base64=include_image_base64,
             image_limit=image_limit,
             image_min_size=image_min_size,
+            bbox_annotation_format=utils.get_pydantic_model(
+                bbox_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
+            document_annotation_format=utils.get_pydantic_model(
+                document_annotation_format, OptionalNullable[models.ResponseFormat]
+            ),
         )
 
         req = self._build_request_async(

mistralai/sdk.py

@@ -10,6 +10,7 @@ from mistralai import models, utils
 from mistralai._hooks import SDKHooks
 from mistralai.agents import Agents
 from mistralai.batch import Batch
+from mistralai.beta import Beta
 from mistralai.chat import Chat
 from mistralai.classifiers import Classifiers
 from mistralai.embeddings import Embeddings
@@ -28,6 +29,7 @@ class Mistral(BaseSDK):
 
     models: Models
     r"""Model Management API"""
+    beta: Beta
     files: Files
     r"""Files API"""
     fine_tuning: FineTuning
@@ -142,6 +144,7 @@ class Mistral(BaseSDK):
 
     def _init_sdks(self):
         self.models = Models(self.sdk_configuration)
+        self.beta = Beta(self.sdk_configuration)
         self.files = Files(self.sdk_configuration)
         self.fine_tuning = FineTuning(self.sdk_configuration)
         self.batch = Batch(self.sdk_configuration)

{mistralai-1.7.0.dist-info → mistralai-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mistralai
-Version: 1.7.0
+Version: 1.8.0
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
 Requires-Python: >=3.9
@@ -10,10 +10,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: agents
 Provides-Extra: gcp
+Requires-Dist: authlib (>=1.5.2,<2.0) ; extra == "agents"
 Requires-Dist: eval-type-backport (>=0.2.0)
 Requires-Dist: google-auth (>=2.27.0) ; extra == "gcp"
+Requires-Dist: griffe (>=1.7.3,<2.0) ; extra == "agents"
 Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: mcp (>=1.0,<2.0) ; (python_version >= "3.10") and (extra == "agents")
 Requires-Dist: pydantic (>=2.10.3)
 Requires-Dist: python-dateutil (>=2.8.2)
 Requires-Dist: requests (>=2.32.3) ; extra == "gcp"
@@ -131,6 +135,18 @@ Once that is saved to a file, you can run it with `uv run script.py` where
 `script.py` can be replaced with the actual file name.
 <!-- End SDK Installation [installation] -->
 
+### Agents extra dependencies
+
+When using the agents related feature it is required to add the `agents` extra dependencies. This can be added when 
+installing the package:
+
+```bash
+pip install "mistralai[agents]"
+```
+
+> Note: Because of some of our dependencies, these features are only available for python version higher or equal to 
+> 3.10.
+
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
 
@@ -455,6 +471,30 @@ The documentation for the GCP SDK is available [here](https://github.com/mistral
 * [get](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#get) - Get Batch Job
 * [cancel](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistraljobs/README.md#cancel) - Cancel Batch Job
 
+### [beta](https://github.com/mistralai/client-python/blob/master/docs/sdks/beta/README.md)
+
+
+#### [beta.agents](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md)
+
+* [create](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md#create) - Create a agent that can be used within a conversation.
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md#list) - List agent entities.
+* [get](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md#get) - Retrieve an agent entity.
+* [update](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md#update) - Update an agent entity.
+* [update_version](https://github.com/mistralai/client-python/blob/master/docs/sdks/mistralagents/README.md#update_version) - Update an agent version.
+
+#### [beta.conversations](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md)
+
+* [start](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#start) - Create a conversation and append entries to it.
+* [list](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#list) - List all created conversations.
+* [get](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#get) - Retrieve a conversation information.
+* [append](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#append) - Append new entries to an existing conversation.
+* [get_history](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#get_history) - Retrieve all entries in a conversation.
+* [get_messages](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#get_messages) - Retrieve all messages in a conversation.
+* [restart](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#restart) - Restart a conversation starting from a given entry.
+* [start_stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#start_stream) - Create a conversation and append entries to it.
+* [append_stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#append_stream) - Append new entries to an existing conversation.
+* [restart_stream](https://github.com/mistralai/client-python/blob/master/docs/sdks/conversations/README.md#restart_stream) - Restart a conversation starting from a given entry.
+
 ### [chat](https://github.com/mistralai/client-python/blob/master/docs/sdks/chat/README.md)
 
 * [complete](https://github.com/mistralai/client-python/blob/master/docs/sdks/chat/README.md#complete) - Chat Completion
@@ -534,12 +574,7 @@ with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
 ) as mistral:
 
-    res = mistral.chat.stream(model="mistral-small-latest", messages=[
-        {
-            "content": "Who is the best French painter? Answer in one short sentence.",
-            "role": "user",
-        },
-    ])
+    res = mistral.beta.conversations.start_stream(inputs="<value>")
 
     with res as event_stream:
         for event in event_stream: