# ImageGenTool

> **Class** in `langchain_azure_ai`

📖 [View in docs](https://reference.langchain.com/python/langchain-azure-ai/agents/_v2/prebuilt/tools/ImageGenTool)

A wrapper around the Foundry ImageGenTool for use in AgentServiceBaseToolV2.

This class exists to provide a consistent import path for users who want
to use the ImageGenTool with AgentServiceBaseToolV2, without needing to
import from azure.ai.projects.models directly.

## Signature

```python
ImageGenTool(
    self,
    model: Literal['gpt-image-1'] = 'gpt-image-1',
    model_deployment: str = 'gpt-image-1',
    quality: Literal['low', 'medium', 'high', 'auto'] | None = None,
    size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] | None = None,
    output_format: Literal['png', 'webp', 'jpeg'] | None = None,
    output_compression: int | None = None,
    moderation: Literal['auto', 'low'] | None = None,
    background: Literal['transparent', 'opaque', 'auto'] | None = None,
    input_image_mask: ImageGenToolInputImageMask | None = None,
    partial_images: int | None = None,
)
```

## Extends

- `AgentServiceBaseTool`

## Constructors

```python
__init__(
    self,
    model: Literal['gpt-image-1'] = 'gpt-image-1',
    model_deployment: str = 'gpt-image-1',
    quality: Literal['low', 'medium', 'high', 'auto'] | None = None,
    size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] | None = None,
    output_format: Literal['png', 'webp', 'jpeg'] | None = None,
    output_compression: int | None = None,
    moderation: Literal['auto', 'low'] | None = None,
    background: Literal['transparent', 'opaque', 'auto'] | None = None,
    input_image_mask: ImageGenToolInputImageMask | None = None,
    partial_images: int | None = None,
)
```

| Name | Type |
|------|------|
| `model` | `Literal['gpt-image-1']` |
| `model_deployment` | `str` |
| `quality` | `Literal['low', 'medium', 'high', 'auto'] \| None` |
| `size` | `Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] \| None` |
| `output_format` | `Literal['png', 'webp', 'jpeg'] \| None` |
| `output_compression` | `int \| None` |
| `moderation` | `Literal['auto', 'low'] \| None` |
| `background` | `Literal['transparent', 'opaque', 'auto'] \| None` |
| `input_image_mask` | `ImageGenToolInputImageMask \| None` |
| `partial_images` | `int \| None` |


---

[View source on GitHub](https://github.com/langchain-ai/langchain-azure/blob/7a6a664d617264df8dcb12fcfb1bacc09f21d504/libs/azure-ai/langchain_azure_ai/agents/_v2/prebuilt/tools.py#L72)