ImageGenTool Class

A tool that generates images using a model like gpt-image-1.

Constructor

ImageGenTool(*args: Any, **kwargs: Any)

Variables

Name	Description
type	str or <xref:azure.ai.projects.models.IMAGE_GENERATION> The type of the image generation tool. Always image_generation. Required.
model	str The image generation model to use. Default: gpt-image-1. Default value is "gpt-image-1".
quality	str or str or str or str The quality of the generated image. One of low, medium, high, or auto. Default: auto. Is one of the following types: Literal["low"], Literal["medium"], Literal["high"], Literal["auto"]
size	str or str or str or str The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto. Is one of the following types: Literal["1024x1024"], Literal["1024x1536"], Literal["1536x1024"], Literal["auto"]
output_format	str or str or str The output format of the generated image. One of png, webp, or jpeg. Default: png. Is one of the following types: Literal["png"], Literal["webp"], Literal["jpeg"]
output_compression	int Compression level for the output image. Default: 100.
moderation	str or str Moderation level for the generated image. Default: auto. Is either a Literal["auto"] type or a Literal["low"] type.
background	str or str or str Background type for the generated image. One of transparent, opaque, or auto. Default: auto. Is one of the following types: Literal["transparent"], Literal["opaque"], Literal["auto"]
input_image_mask	ImageGenToolInputImageMask Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).
partial_images	int Number of partial images to generate in streaming mode, from 0 (default value) to 3.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

background

Background type for the generated image. One of transparent, opaque, or auto. Default: auto. Is one of the following types: Literal["transparent"], Literal["opaque"], Literal["auto"]

background: Literal['transparent', 'opaque', 'auto'] | None

input_image_mask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

input_image_mask: _models.ImageGenToolInputImageMask | None

model

gpt-image-1. Default value is "gpt-image-1".

model: Literal['gpt-image-1'] | None

moderation

auto. Is either a Literal["auto"] type or a Literal["low"] type.

moderation: Literal['auto', 'low'] | None

output_compression

output_compression: int | None

output_format

The output format of the generated image. One of png, webp, or jpeg. Default: png. Is one of the following types: Literal["png"], Literal["webp"], Literal["jpeg"]

output_format: Literal['png', 'webp', 'jpeg'] | None

partial_images

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

partial_images: int | None

quality

The quality of the generated image. One of low, medium, high, or auto. Default: auto. Is one of the following types: Literal["low"], Literal["medium"], Literal["high"], Literal["auto"]

quality: Literal['low', 'medium', 'high', 'auto'] | None

size

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto. Is one of the following types: Literal["1024x1024"], Literal["1024x1536"], Literal["1536x1024"], Literal["auto"]

size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] | None

type

The type of the image generation tool. Always image_generation. Required.

type: IMAGE_GENERATION: 'image_generation'>]