Skip to content

azure

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

azure

README.md

Mistral on Azure Python Client

SDK Installation

PIP

pip install mistralai

UV

uv add mistralai

Prerequisites

Before you begin, ensure you have AZURE_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.

SDK Example Usage

Create Chat Completions

This example shows how to create chat completions.

The SDK automatically injects the api-version query parameter.

# Synchronous Example
from mistralai.azure.client import MistralAzure
import os

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ.get("AZURE_API_VERSION", "2024-05-01-preview")

# The SDK automatically injects api-version as a query parameter
s = MistralAzure(
    api_key=AZURE_API_KEY,
    server_url=AZURE_ENDPOINT,
    api_version=AZURE_API_VERSION,
)

res = s.chat.complete(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=AZURE_MODEL,
)

if res is not None:
    # handle response
    print(res.choices[0].message.content)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import os
from mistralai.azure.client import MistralAzure

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ.get("AZURE_API_VERSION", "2024-05-01-preview")

async def main():
    # The SDK automatically injects api-version as a query parameter
    s = MistralAzure(
        api_key=AZURE_API_KEY,
        server_url=AZURE_ENDPOINT,
        api_version=AZURE_API_VERSION,
    )
    res = await s.chat.complete_async(
        messages=[
            {
                "role": "user",
                "content": "Who is the best French painter? Answer in one short sentence.",
            },
        ],
        model=AZURE_MODEL,
    )
    if res is not None:
        # handle response
        print(res.choices[0].message.content)

asyncio.run(main())

Available Resources and Operations

chat

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as 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.

from mistralai.azure.client import MistralAzure
import os

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ.get("AZURE_API_VERSION", "2024-05-01-preview")

# The SDK automatically injects api-version as a query parameter
s = MistralAzure(
    api_key=AZURE_API_KEY,
    server_url=AZURE_ENDPOINT,
    api_version=AZURE_API_VERSION,
)

res = s.chat.stream(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=AZURE_MODEL,
)

if res is not None:
    for event in res:
        # handle event
        print(event)

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from mistralai.azure.client import MistralAzure
from mistralai.azure.client.utils import BackoffStrategy, RetryConfig
import os

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ.get("AZURE_API_VERSION", "2024-05-01-preview")

# The SDK automatically injects api-version as a query parameter
s = MistralAzure(
    api_key=AZURE_API_KEY,
    server_url=AZURE_ENDPOINT,
    api_version=AZURE_API_VERSION,
)

res = s.chat.stream(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=AZURE_MODEL,
    retries=RetryConfig(
        "backoff",
        BackoffStrategy(1, 50, 1.1, 100),
        False
    ),
)

if res is not None:
    for event in res:
        # handle event
        print(event)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from mistralai.azure.client import MistralAzure
from mistralai.azure.client.utils import BackoffStrategy, RetryConfig
import os

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ["AZURE_API_VERSION"]

# The SDK automatically injects api-version as a query parameter
s = MistralAzure(
    api_key=AZURE_API_KEY,
    server_url=AZURE_ENDPOINT,
    api_version=AZURE_API_VERSION,
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
)

res = s.chat.stream(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=AZURE_MODEL,
)

if res is not None:
    for event in res:
        # handle event
        print(event)

Error Handling

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 /

Example

from mistralai.azure.client import MistralAzure
from mistralai.azure.client import models
import os

AZURE_API_KEY = os.environ["AZURE_API_KEY"]
AZURE_ENDPOINT = os.environ["AZURE_ENDPOINT"]
AZURE_MODEL = os.environ["AZURE_MODEL"]
AZURE_API_VERSION = os.environ.get("AZURE_API_VERSION", "2024-05-01-preview")

# The SDK automatically injects api-version as a query parameter
s = MistralAzure(
    api_key=AZURE_API_KEY,
    server_url=AZURE_ENDPOINT,
    api_version=AZURE_API_VERSION,
)

res = None
try:
    res = s.chat.complete(
        messages=[
            {
                "role": "user",
                "content": "Who is the best French painter? Answer in one short sentence.",
            },
        ],
        model=AZURE_MODEL,
    )

except models.HTTPValidationError as e:
    # handle exception
    raise(e)
except models.SDKError as e:
    # handle exception
    raise(e)

if res is not None:
    # handle response
    pass

Server Selection

Override Server URL Per-Client

For Azure, you must provide your Azure AI Foundry endpoint via server_url. The SDK automatically injects the api-version query parameter:

from mistralai.azure.client import MistralAzure
import os

s = MistralAzure(
    api_key=os.environ["AZURE_API_KEY"],
    server_url=os.environ["AZURE_ENDPOINT"],
    api_version=os.environ.get("AZURE_API_VERSION", "2024-05-01-preview"),
)

res = s.chat.stream(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=os.environ["AZURE_MODEL"],
)

if res is not None:
    for event in res:
        # handle event
        print(event)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocols ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this SDK makes as follows:

from mistralai.azure.client import MistralAzure
import httpx
import os

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = MistralAzure(
    api_key=os.environ["AZURE_API_KEY"],
    server_url=os.environ["AZURE_ENDPOINT"],
    api_version=os.environ.get("AZURE_API_VERSION", "2024-05-01-preview"),
    client=http_client,
)

or you could wrap the client with your own custom logic:

from typing import Any, Optional, Union
from mistralai.azure.client import MistralAzure
from mistralai.azure.client.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = MistralAzure(
    api_key="<your-azure-api-key>",
    server_url="<your-azure-endpoint>",
    async_client=CustomClient(httpx.AsyncClient()),
)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
api_key http HTTP Bearer

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. You must also provide server_url pointing to your Azure AI Foundry endpoint. The SDK automatically injects the api-version query parameter:

from mistralai.azure.client import MistralAzure
import os

s = MistralAzure(
    api_key=os.environ["AZURE_API_KEY"],
    server_url=os.environ["AZURE_ENDPOINT"],
    api_version=os.environ.get("AZURE_API_VERSION", "2024-05-01-preview"),
)

res = s.chat.stream(
    messages=[
        {
            "role": "user",
            "content": "Who is the best French painter? Answer in one short sentence.",
        },
    ],
    model=os.environ["AZURE_MODEL"],
)

if res is not None:
    for event in res:
        # handle event
        print(event)

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.