| Name | Type | Description |
|---|---|---|
model_deployment | Optional[str] | Default: NoneDeployment name of the image generation model in
Azure AI Foundry. When set, the
|
model | Optional[Literal['gpt-image-1', 'gpt-image-1-mini', 'gpt-image-1.5']] | Default: NoneImage generation model to use (e.g. |
action | Optional[Literal['generate', 'edit', 'auto']] | Default: None |
background | Optional[Literal['transparent', 'opaque', 'auto']] | Default: None |
input_fidelity | Optional[str] | Default: None |
input_image_mask | Optional[ImageGenerationInputImageMask] | Default: None |
moderation | Optional[Literal['auto', 'low']] | Default: None |
output_compression | Optional[int] | Default: None |
output_format | Optional[Literal['png', 'webp', 'jpeg']] | Default: None |
partial_images | Optional[int] | Default: None |
quality | Optional[Literal['low', 'medium', 'high', 'auto']] | Default: None |
size | Optional[Literal['1024x1024', '1024x1536', '1536x1024', 'auto']] | Default: None |
| Name | Type |
|---|---|
| model | Optional[Literal['gpt-image-1', 'gpt-image-1-mini', 'gpt-image-1.5']] |
| model_deployment | Optional[str] |
| action | Optional[Literal['generate', 'edit', 'auto']] |
| background | Optional[Literal['transparent', 'opaque', 'auto']] |
| input_fidelity | Optional[str] |
| input_image_mask | Optional[ImageGenerationInputImageMask] |
| moderation | Optional[Literal['auto', 'low']] |
| output_compression | Optional[int] |
| output_format | Optional[Literal['png', 'webp', 'jpeg']] |
| partial_images | Optional[int] |
| quality | Optional[Literal['low', 'medium', 'high', 'auto']] |
| size | Optional[Literal['1024x1024', '1024x1536', '1536x1024', 'auto']] |
A tool that generates or edits images using GPT image models.
Wraps :class:openai.types.responses.tool_param.ImageGeneration.
When model_deployment is specified the tool automatically injects
an x-ms-oai-image-generation-deployment HTTP header into every
inference API call made via :meth:model.bind_tools. This tells the
Azure AI Foundry endpoint which model deployment to use for image
generation.
Example::
from langchain_azure_ai.tools.builtin import ImageGenerationTool
tool = ImageGenerationTool(
quality="high",
size="1024x1024",
model_deployment="my-gpt-image-1-deployment",
)
model_with_img = model.bind_tools([tool])
Whether to generate a new image or edit an existing one.
One of "generate", "edit", or "auto" (default).
Background type. One of "transparent",
"opaque", or "auto" (default).
How closely the output should match style and
facial features of input images. One of "high" or
"low".
Mask for inpainting. Use
:class:~openai.types.responses.tool_param.ImageGenerationInputImageMask
or a plain :class:dict with optional image_url / file_id
keys.
Moderation level. One of "auto" (default) or
"low".
Compression level (0–100, default 100).
Output format. One of "png" (default),
"webp", or "jpeg".
Number of partial images to stream (0–3).
Image quality. One of "low", "medium",
"high", or "auto" (default).
Image size. One of "1024x1024", "1024x1536",
"1536x1024", or "auto" (default).