> ## Documentation Index
> Fetch the complete documentation index at: https://agno-v2-update-deprecated-models.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure OpenAI

> AzureOpenAITools provides access to Azure OpenAI services including DALL-E image generation.

## Prerequisites

The following examples require the `requests` library:

```shell theme={null}
uv pip install -U requests
```

Set the following environment variables:

```shell theme={null}
export AZURE_OPENAI_API_KEY="your-azure-openai-api-key"
export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com"
export AZURE_OPENAI_API_VERSION="2023-12-01-preview"
export AZURE_OPENAI_IMAGE_DEPLOYMENT="your-dalle-deployment-name"
```

## Example

The following agent can generate images using Azure OpenAI's DALL-E:

```python theme={null}
from agno.agent import Agent
from agno.tools.models.azure_openai import AzureOpenAITools

agent = Agent(
    instructions=[
        "You are an AI image generation assistant using Azure OpenAI",
        "Generate high-quality images based on user descriptions",
        "Provide detailed descriptions of the generated images",
    ],
    tools=[AzureOpenAITools()],
)

agent.print_response("Generate an image of a sunset over mountains", stream=True)
```

## Toolkit Params

| Parameter               | Type            | Default                | Description                                                     |
| ----------------------- | --------------- | ---------------------- | --------------------------------------------------------------- |
| `api_key`               | `Optional[str]` | `None`                 | Azure OpenAI API key. Uses AZURE\_OPENAI\_API\_KEY if not set.  |
| `azure_endpoint`        | `Optional[str]` | `None`                 | Azure OpenAI endpoint. Uses AZURE\_OPENAI\_ENDPOINT if not set. |
| `api_version`           | `Optional[str]` | `"2023-12-01-preview"` | Azure OpenAI API version.                                       |
| `image_deployment`      | `Optional[str]` | `None`                 | DALL-E deployment name. Uses AZURE\_OPENAI\_IMAGE\_DEPLOYMENT.  |
| `image_model`           | `str`           | `"dall-e-3"`           | DALL-E model to use (dall-e-2, dall-e-3).                       |
| `image_quality`         | `Literal`       | `"standard"`           | Image quality: "standard" or "hd" (hd only for dall-e-3).       |
| `enable_generate_image` | `bool`          | `True`                 | Enable the generate image functionality                         |
| `all`                   | `bool`          | `False`                | Enable all functionality when set to True                       |

## Toolkit Functions

| Function         | Description                                       |
| ---------------- | ------------------------------------------------- |
| `generate_image` | Generate images using Azure OpenAI DALL-E models. |

You can use `include_tools` or `exclude_tools` to modify the list of tools the agent has access to. Learn more about [selecting tools](/tools/selecting-tools).

## Developer Resources

* View [Tools Source](https://github.com/agno-agi/agno/blob/main/libs/agno/agno/tools/models/azure_openai.py)
* [Azure OpenAI Documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/openai/)
