mistralai 1.2.3__tar.gz → 1.2.4__tar.gz

{mistralai-1.2.3 → mistralai-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mistralai
-Version: 1.2.3
+Version: 1.2.4
 Summary: Python Client SDK for the Mistral AI API.
 Home-page: https://github.com/mistralai/client-python.git
 Author: Mistral
@@ -18,7 +18,7 @@ Requires-Dist: google-auth (==2.27.0) ; extra == "gcp"
 Requires-Dist: httpx (>=0.27.0,<0.28.0)
 Requires-Dist: jsonpath-python (>=1.0.6,<2.0.0)
 Requires-Dist: pydantic (>=2.9.0,<3.0.0)
-Requires-Dist: python-dateutil (==2.8.2)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "gcp"
 Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
 Project-URL: Repository, https://github.com/mistralai/client-python.git
@@ -53,19 +53,26 @@ Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create yo
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Mistral Python Client](https://github.com/mistralai/client-python/blob/master/#mistral-python-client)
+  * [Migration warning](https://github.com/mistralai/client-python/blob/master/#migration-warning)
+  * [API Key Setup](https://github.com/mistralai/client-python/blob/master/#api-key-setup)
+  * [SDK Installation](https://github.com/mistralai/client-python/blob/master/#sdk-installation)
+  * [SDK Example Usage](https://github.com/mistralai/client-python/blob/master/#sdk-example-usage)
+  * [Providers' SDKs Example Usage](https://github.com/mistralai/client-python/blob/master/#providers-sdks-example-usage)
+  * [Available Resources and Operations](https://github.com/mistralai/client-python/blob/master/#available-resources-and-operations)
+  * [Server-sent event streaming](https://github.com/mistralai/client-python/blob/master/#server-sent-event-streaming)
+  * [File uploads](https://github.com/mistralai/client-python/blob/master/#file-uploads)
+  * [Retries](https://github.com/mistralai/client-python/blob/master/#retries)
+  * [Error Handling](https://github.com/mistralai/client-python/blob/master/#error-handling)
+  * [Server Selection](https://github.com/mistralai/client-python/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/mistralai/client-python/blob/master/#custom-http-client)
+  * [Authentication](https://github.com/mistralai/client-python/blob/master/#authentication)
+  * [Debugging](https://github.com/mistralai/client-python/blob/master/#debugging)
+  * [IDE Support](https://github.com/mistralai/client-python/blob/master/#ide-support)
+* [Development](https://github.com/mistralai/client-python/blob/master/#development)
+  * [Contributions](https://github.com/mistralai/client-python/blob/master/#contributions)
 
-* [SDK Installation](https://github.com/mistralai/client-python/blob/master/#sdk-installation)
-* [IDE Support](https://github.com/mistralai/client-python/blob/master/#ide-support)
-* [SDK Example Usage](https://github.com/mistralai/client-python/blob/master/#sdk-example-usage)
-* [Available Resources and Operations](https://github.com/mistralai/client-python/blob/master/#available-resources-and-operations)
-* [Server-sent event streaming](https://github.com/mistralai/client-python/blob/master/#server-sent-event-streaming)
-* [File uploads](https://github.com/mistralai/client-python/blob/master/#file-uploads)
-* [Retries](https://github.com/mistralai/client-python/blob/master/#retries)
-* [Error Handling](https://github.com/mistralai/client-python/blob/master/#error-handling)
-* [Server Selection](https://github.com/mistralai/client-python/blob/master/#server-selection)
-* [Custom HTTP Client](https://github.com/mistralai/client-python/blob/master/#custom-http-client)
-* [Authentication](https://github.com/mistralai/client-python/blob/master/#authentication)
-* [Debugging](https://github.com/mistralai/client-python/blob/master/#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -102,20 +109,19 @@ This example shows how to create chat completions.
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.chat.complete(model="mistral-small-latest", messages=[
-    {
-        "content": "Who is the best French painter? Answer in one short sentence.",
-        "role": "user",
-    },
-])
+) as s:
+    res = s.chat.complete(model="mistral-small-latest", messages=[
+        {
+            "content": "Who is the best French painter? Answer in one short sentence.",
+            "role": "user",
+        },
+    ])
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -128,18 +134,19 @@ from mistralai import Mistral
 import os
 
 async def main():
-    s = Mistral(
+    async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
-    )
-    res = await s.chat.complete_async(model="mistral-small-latest", messages=[
-        {
-            "content": "Who is the best French painter? Answer in one short sentence.",
-            "role": "user",
-        },
-    ])
-    if res is not None:
-        # handle response
-        pass
+    ) as s:
+        res = await s.chat.complete_async(model="mistral-small-latest", messages=[
+            {
+                "content": "Who is the best French painter? Answer in one short sentence.",
+                "role": "user",
+            },
+        ])
+
+        if res is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -153,18 +160,17 @@ This example shows how to upload a file.
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.files.upload(file={
-    "file_name": "example.file",
-    "content": open("example.file", "rb"),
-})
+) as s:
+    res = s.files.upload(file={
+        "file_name": "example.file",
+        "content": open("example.file", "rb"),
+    })
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -177,16 +183,17 @@ from mistralai import Mistral
 import os
 
 async def main():
-    s = Mistral(
+    async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
-    )
-    res = await s.files.upload_async(file={
-        "file_name": "example.file",
-        "content": open("example.file", "rb"),
-    })
-    if res is not None:
-        # handle response
-        pass
+    ) as s:
+        res = await s.files.upload_async(file={
+            "file_name": "example.file",
+            "content": open("example.file", "rb"),
+        })
+
+        if res is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -200,20 +207,19 @@ This example shows how to create agents completions.
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.agents.complete(messages=[
-    {
-        "content": "Who is the best French painter? Answer in one short sentence.",
-        "role": "user",
-    },
-], agent_id="<value>")
+) as s:
+    res = s.agents.complete(messages=[
+        {
+            "content": "Who is the best French painter? Answer in one short sentence.",
+            "role": "user",
+        },
+    ], agent_id="<value>")
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -226,18 +232,19 @@ from mistralai import Mistral
 import os
 
 async def main():
-    s = Mistral(
+    async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
-    )
-    res = await s.agents.complete_async(messages=[
-        {
-            "content": "Who is the best French painter? Answer in one short sentence.",
-            "role": "user",
-        },
-    ], agent_id="<value>")
-    if res is not None:
-        # handle response
-        pass
+    ) as s:
+        res = await s.agents.complete_async(messages=[
+            {
+                "content": "Who is the best French painter? Answer in one short sentence.",
+                "role": "user",
+            },
+        ], agent_id="<value>")
+
+        if res is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -251,18 +258,17 @@ This example shows how to create embedding request.
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.embeddings.create(inputs=[
-    "Embed this sentence.",
-    "As well as this one.",
-], model="Wrangler")
+) as s:
+    res = s.embeddings.create(inputs=[
+        "Embed this sentence.",
+        "As well as this one.",
+    ], model="Wrangler")
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 ```
 
 </br>
@@ -275,16 +281,17 @@ from mistralai import Mistral
 import os
 
 async def main():
-    s = Mistral(
+    async with Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
-    )
-    res = await s.embeddings.create_async(inputs=[
-        "Embed this sentence.",
-        "As well as this one.",
-    ], model="Wrangler")
-    if res is not None:
-        # handle response
-        pass
+    ) as s:
+        res = await s.embeddings.create_async(inputs=[
+            "Embed this sentence.",
+            "As well as this one.",
+        ], model="Wrangler")
+
+        if res is not None:
+            # handle response
+            pass
 
 asyncio.run(main())
 ```
@@ -427,6 +434,7 @@ The documentation for the GCP SDK is available [here](https://github.com/mistral
 * [retrieve](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#retrieve) - Retrieve File
 * [delete](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#delete) - Delete File
 * [download](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#download) - Download File
+* [get_signed_url](https://github.com/mistralai/client-python/blob/master/docs/sdks/files/README.md#get_signed_url) - Get Signed Url
 
 ### [fim](https://github.com/mistralai/client-python/blob/master/docs/sdks/fim/README.md)
 
@@ -464,32 +472,36 @@ The documentation for the GCP SDK is available [here](https://github.com/mistral
 operations. These operations will expose the stream as [Generator][generator] that
 can be consumed using a simple `for` loop. The loop will
 terminate when the server no longer has any events to send and closes the
-underlying connection.
+underlying connection.  
+
+The stream is also a [Context Manager][context-manager] and can be used with the `with` statement and will close the
+underlying connection when the context is exited.
 
 ```python
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.chat.stream(model="mistral-small-latest", messages=[
-    {
-        "content": "Who is the best French painter? Answer in one short sentence.",
-        "role": "user",
-    },
-])
+) as s:
+    res = s.chat.stream(model="mistral-small-latest", messages=[
+        {
+            "content": "Who is the best French painter? Answer in one short sentence.",
+            "role": "user",
+        },
+    ])
 
-if res is not None:
-    for event in res:
-        # handle event
-        print(event, flush=True)
+    if res is not None:
+        with res as event_stream:
+            for event in event_stream:
+                # handle event
+                print(event, flush=True)
 
 ```
 
 [mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
-[generator]: https://wiki.python.org/moin/Generators
+[generator]: https://book.pythontips.com/en/latest/generators.html
+[context-manager]: https://book.pythontips.com/en/latest/context_managers.html
 <!-- End Server-sent event streaming [eventstream] -->
 
 <!-- Start File uploads [file-upload] -->
@@ -506,18 +518,17 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.files.upload(file={
-    "file_name": "example.file",
-    "content": open("example.file", "rb"),
-})
+) as s:
+    res = s.files.upload(file={
+        "file_name": "example.file",
+        "content": open("example.file", "rb"),
+    })
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End File uploads [file-upload] -->
@@ -533,16 +544,15 @@ from mistral.utils import BackoffStrategy, RetryConfig
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
+) as s:
+    res = s.models.list(,
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-res = s.models.list(,
-    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
-
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 
@@ -552,16 +562,15 @@ from mistral.utils import BackoffStrategy, RetryConfig
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.models.list()
+) as s:
+    res = s.models.list()
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Retries [retries] -->
@@ -593,24 +602,23 @@ When custom error responses are specified for an operation, the SDK may also rai
 from mistralai import Mistral, models
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = None
-try:
-    res = s.models.list()
-
-    if res is not None:
-        # handle response
-        pass
-
-except models.HTTPValidationError as e:
-    # handle e.data: models.HTTPValidationErrorData
-    raise(e)
-except models.SDKError as e:
-    # handle exception
-    raise(e)
+) as s:
+    res = None
+    try:
+        res = s.models.list()
+
+        if res is not None:
+            # handle response
+            pass
+
+    except models.HTTPValidationError as e:
+        # handle e.data: models.HTTPValidationErrorData
+        raise(e)
+    except models.SDKError as e:
+        # handle exception
+        raise(e)
 ```
 <!-- End Error Handling [errors] -->
 
@@ -631,16 +639,15 @@ You can override the default server globally by passing a server name to the `se
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     server="eu",
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.models.list()
+) as s:
+    res = s.models.list()
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 
@@ -651,16 +658,15 @@ The default server can also be overridden globally by passing a URL to the `serv
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     server_url="https://api.mistral.ai",
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.models.list()
+) as s:
+    res = s.models.list()
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Server Selection [server] -->
@@ -762,15 +768,14 @@ To authenticate with the API the `api_key` parameter must be set when initializi
 from mistralai import Mistral
 import os
 
-s = Mistral(
+with Mistral(
     api_key=os.getenv("MISTRAL_API_KEY", ""),
-)
-
-res = s.models.list()
+) as s:
+    res = s.models.list()
 
-if res is not None:
-    # handle response
-    pass
+    if res is not None:
+        # handle response
+        pass
 
 ```
 <!-- End Authentication [security] -->