mistralai 1.0.0rc1__py3-none-any.whl → 1.0.1__py3-none-any.whl

mistralai/utils/eventstreaming.py

@@ -147,15 +147,14 @@ def _parse_event(
         data = data[:-1]
         event.data = data
 
-        if (
-            data.isnumeric()
-            or data == "true"
-            or data == "false"
-            or data == "null"
-            or data.startswith("{")
-            or data.startswith("[")
-            or data.startswith('"')
-        ):
+        data_is_primitive = (
+            data.isnumeric() or data == "true" or data == "false" or data == "null"
+        )
+        data_is_json = (
+            data.startswith("{") or data.startswith("[") or data.startswith('"')
+        )
+
+        if data_is_primitive or data_is_json:
             try:
                 event.data = json.loads(data)
             except Exception:

mistralai/utils/logger.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Any, Protocol
+
+class Logger(Protocol):
+    def debug(self, msg: str, *args: Any, **kwargs: Any) -> None:
+        pass
+
+class NoOpLogger:
+    def debug(self, msg: str, *args: Any, **kwargs: Any) -> None:
+        pass
+
+def get_body_content(req: httpx.Request) -> str:
+    return "<streaming body>" if not hasattr(req, "_content") else str(req.content)
+

mistralai/utils/retries.py

@@ -76,7 +76,7 @@ def retry(func, retries: Retries):
 
                         status_major = res.status_code / 100
 
-                        if status_major >= code_range and status_major < code_range + 1:
+                        if code_range <= status_major < code_range + 1:
                             raise TemporaryError(res)
                     else:
                         parsed_code = int(code)
@@ -125,7 +125,7 @@ async def retry_async(func, retries: Retries):
 
                         status_major = res.status_code / 100
 
-                        if status_major >= code_range and status_major < code_range + 1:
+                        if code_range <= status_major < code_range + 1:
                             raise TemporaryError(res)
                     else:
                         parsed_code = int(code)

mistralai/utils/security.py

@@ -53,11 +53,14 @@ def get_security(security: Any) -> Tuple[Dict[str, str], Dict[str, List[str]]]:
     return headers, query_params
 
 
-def get_security_from_env(security_class: Any) -> Optional[BaseModel]:
+def get_security_from_env(security: Any, security_class: Any) -> Optional[BaseModel]:
+    if security is not None:
+        return security
+
     if not issubclass(security_class, BaseModel):
         raise TypeError("security_class must be a pydantic model class")
 
-    security_dict = {}
+    security_dict: Any = {}
 
     if os.getenv("MISTRAL_API_KEY"):
         security_dict["api_key"] = os.getenv("MISTRAL_API_KEY")

{mistralai-1.0.0rc1.dist-info → mistralai-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mistralai
-Version: 1.0.0rc1
+Version: 1.0.1
 Summary: Python Client SDK for the Mistral AI API.
 Author: Mistral
 Requires-Python: >=3.8,<4.0
@@ -20,15 +20,26 @@ Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "gcp"
 Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
 Description-Content-Type: text/markdown
 
-# mistralai
-
-<div align="left">
-    <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
-</div>
+# Mistral Python Client
 
 ## Migration warning
  
-This documentation is for Mistralai SDK v1. You can find more details on how to migrate from v0 to v1 [here](MIGRATION.md)
+This documentation is for Mistral AI SDK v1. You can find more details on how to migrate from v0 to v1 [here](MIGRATION.md)
+
+## API Key Setup
+
+Before you begin, you will need a Mistral AI API key.
+
+1. Get your own Mistral API Key: <https://docs.mistral.ai/#api-access>
+2. Set your Mistral API Key as an environment variable. You only need to do this once.
+
+```bash
+# set Mistral API Key (using zsh for example)
+$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv
+
+# reload the environment (or just quit and open a new terminal)
+$ source ~/.zshenv
+```
 
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
@@ -61,12 +72,12 @@ s = Mistral(
 )
 
 
-res = s.chat.create(messages=[
+res = s.chat.complete(model="mistral-small-latest", messages=[
     {
         "content": "Who is the best French painter? Answer in one short sentence.",
         "role": "user",
     },
-], model="mistral-small-latest")
+])
 
 if res is not None:
     # handle response
@@ -86,12 +97,12 @@ async def main():
     s = Mistral(
         api_key=os.getenv("MISTRAL_API_KEY", ""),
     )
-    res = await s.chat.create_async(messages=[
+    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",
         },
-    ], model="mistral-small-latest")
+    ])
     if res is not None:
         # handle response
         pass
@@ -144,17 +155,78 @@ async def main():
         # handle response
         pass
 
+asyncio.run(main())
+```
+
+### Create Agents Completions
+
+This example shows how to create agents completions.
+
+```python
+# Synchronous Example
+from mistralai import Mistral
+import os
+
+s = 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>")
+
+if res is not None:
+    # handle response
+    pass
+```
+
+</br>
+
+The same SDK client can also be used to make asychronous requests by importing asyncio.
+```python
+# Asynchronous Example
+import asyncio
+from mistralai import Mistral
+import os
+
+async def main():
+    s = 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
+
 asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+
+### More examples
+
+You can run the examples in the `examples/` directory using `poetry run` or by entering the virtual environment using `poetry shell`.
+
+
+## Providers' SDKs Example Usage
+
 ### Azure AI
 
 **Prerequisites**
+
 Before you begin, ensure you have `AZUREAI_ENDPOINT` and an `AZURE_API_KEY`. To obtain these, you will need to deploy Mistral on Azure AI.
 See [instructions for deploying Mistral on Azure AI here](https://docs.mistral.ai/deployment/cloud/azure/).
 
-Here's a basic example to get you started. You can also run [the example in the `examples` directory](/examples/azure/).
+Here's a basic example to get you started. You can also run [the example in the `examples` directory](/examples/azure).
 
 ```python
 import asyncio
@@ -164,33 +236,32 @@ from mistralai_azure import MistralAzure
 
 client = MistralAzure(
     azure_api_key=os.getenv("AZURE_API_KEY", ""),
-    azure_endpoint="your_azure_endpoint"
+    azure_endpoint=os.getenv("AZURE_ENDPOINT", "")
 )
 
 async def main() -> None:
-    res = await client.chat.create_async(
-        request={
-            "max_tokens": 100,
-            "temperature": 0.5,
-            "messages": [
-                {
-                    "content": "Hello there!",
-                    "role": "user"
-                }
-            ]
-        }
+    res = await client.chat.complete_async( 
+        max_tokens= 100,
+        temperature= 0.5,
+        messages= [
+            {
+                "content": "Hello there!",
+                "role": "user"
+            }
+        ]
     )
     print(res)
 
 asyncio.run(main())
 ```
-The documentation for the Azure SDK is available [here](/packages/mistralai_azure/README.md).
+The documentation for the Azure SDK is available [here](packages/mistralai_azure/README.md).
 
 ### Google Cloud
 
+
 **Prerequisites**
 
-Before you begin, you will need to create a Google Cloud project and enable the Mistral API. To do this, follow the instructions [here](https://docs.mistral.ai/deployment/cloud/google/).
+Before you begin, you will need to create a Google Cloud project and enable the Mistral API. To do this, follow the instructions [here](https://docs.mistral.ai/deployment/cloud/vertex/).
 
 To run this locally you will also need to ensure you are authenticated with Google Cloud. You can do this by running
 
@@ -218,23 +289,21 @@ client = MistralGoogleCloud()
 
 
 async def main() -> None:
-    res = await client.chat.create_async(
-        request={
-            "model": "mistral-small-2402",
-            "messages": [
-                {
-                    "content": "Hello there!",
-                    "role": "user"
-                }
-            ]
-        }
+    res = await client.chat.complete_async(
+        model= "mistral-small-2402",
+        messages= [
+            {
+                "content": "Hello there!",
+                "role": "user"
+            }
+        ]
     )
     print(res)
 
 asyncio.run(main())
 ```
 
-The documentation for the GCP SDK is available [here](/packages/mistralai_gcp/README.md).
+The documentation for the GCP SDK is available [here](packages/mistralai_gcp/README.md).
 
 
 <!-- Start Available Resources and Operations [operations] -->
@@ -256,24 +325,30 @@ The documentation for the GCP SDK is available [here](/packages/mistralai_gcp/RE
 * [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File
 * [delete](docs/sdks/files/README.md#delete) - Delete File
 
-### [fine_tuning](docs/sdks/finetuning/README.md)
 
-* [list_jobs](docs/sdks/finetuning/README.md#list_jobs) - Get Fine Tuning Jobs
-* [create_job](docs/sdks/finetuning/README.md#create_job) - Create Fine Tuning Job
-* [get_job](docs/sdks/finetuning/README.md#get_job) - Get Fine Tuning Job
-* [cancel_job](docs/sdks/finetuning/README.md#cancel_job) - Cancel Fine Tuning Job
-* [start_job](docs/sdks/finetuning/README.md#start_job) - Start Fine Tuning Job
+### [fine_tuning.jobs](docs/sdks/jobs/README.md)
+
+* [list](docs/sdks/jobs/README.md#list) - Get Fine Tuning Jobs
+* [create](docs/sdks/jobs/README.md#create) - Create Fine Tuning Job
+* [get](docs/sdks/jobs/README.md#get) - Get Fine Tuning Job
+* [cancel](docs/sdks/jobs/README.md#cancel) - Cancel Fine Tuning Job
+* [start](docs/sdks/jobs/README.md#start) - Start Fine Tuning Job
 
 ### [chat](docs/sdks/chat/README.md)
 
-* [create](docs/sdks/chat/README.md#create) - Chat Completion
+* [complete](docs/sdks/chat/README.md#complete) - Chat Completion
 * [stream](docs/sdks/chat/README.md#stream) - Stream chat completion
 
 ### [fim](docs/sdks/fim/README.md)
 
-* [create](docs/sdks/fim/README.md#create) - Fim Completion
+* [complete](docs/sdks/fim/README.md#complete) - Fim Completion
 * [stream](docs/sdks/fim/README.md#stream) - Stream fim completion
 
+### [agents](docs/sdks/agents/README.md)
+
+* [complete](docs/sdks/agents/README.md#complete) - Agents Completion
+* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion
+
 ### [embeddings](docs/sdks/embeddings/README.md)
 
 * [create](docs/sdks/embeddings/README.md#create) - Embeddings
@@ -297,12 +372,12 @@ s = Mistral(
 )
 
 
-res = s.chat.stream(messages=[
+res = s.chat.stream(model="mistral-small-latest", messages=[
     {
         "content": "Who is the best French painter? Answer in one short sentence.",
         "role": "user",
     },
-], model="mistral-small-latest")
+])
 
 if res is not None:
     for event in res:
@@ -397,10 +472,10 @@ if res is not None:
 
 Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
 
-| Error Object               | Status Code | Content Type     |
-| -------------------------- | ----------- | ---------------- |
-| models.HTTPValidationError | 422         | application/json |
-| models.SDKError            | 4xx-5xx     | */*              |
+| Error Object               | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.HTTPValidationError | 422                        | application/json           |
+| models.SDKError            | 4xx-5xx                    | */*                        |
 
 ### Example
 
@@ -437,9 +512,9 @@ if res is not None:
 
 You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
 
-| Name   | Server                   | Variables |
-| ------ | ------------------------ | --------- |
-| `prod` | `https://api.mistral.ai` | None      |
+| Name | Server | Variables |
+| ----- | ------ | --------- |
+| `prod` | `https://api.mistral.ai` | None |
 
 #### Example
 
@@ -572,9 +647,9 @@ s = Mistral(async_client=CustomClient(httpx.AsyncClient()))
 
 This SDK supports the following security scheme globally:
 
-| Name      | Type | Scheme      |
-| --------- | ---- | ----------- |
-| `api_key` | http | HTTP Bearer |
+| Name                 | Type                 | Scheme               | Environment Variable |
+| -------------------- | -------------------- | -------------------- | -------------------- |
+| `api_key`            | http                 | HTTP Bearer          | `MISTRAL_API_KEY`    |
 
 To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
 ```python
@@ -594,28 +669,37 @@ if res is not None:
 
 ```
 <!-- End Authentication [security] -->
-## Providers Support
 
-We also provide provider specific SDK for:
+<!-- Start Debugging [debug] -->
+## Debugging
+
+To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
+
+```python
+from mistralai import Mistral
+import logging
 
-- [GCP](packages/mistralai_gcp/README.md)
-- [Azure](packages/mistralai_azure/README.md)
+logging.basicConfig(level=logging.DEBUG)
+s = Mistral(debug_logger=logging.getLogger("mistralai"))
+```
+<!-- End Debugging [debug] -->
 
+<!-- Start IDE Support [idesupport] -->
+## IDE Support
 
-<!-- Placeholder for Future Speakeasy SDK Sections -->
+### PyCharm
 
-# Development
+Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
 
-## Maturity
+- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
+<!-- End IDE Support [idesupport] -->
 
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
-to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
-looking for the latest version.
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
 
 ## Contributions
 
 While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
 We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
 
-### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
-