ImageGenTool interface

Paquet:

@azure/ai-projects

Un outil qui génère des images à partir des modèles d’images GPT.

Extends

Tool

Propriétés

action	Que ce soit pour générer une nouvelle image ou modifier une image existante. Par défaut : auto.
background	Type d’arrière-plan pour l’image générée. Valeurs possibles : transparent, opaque ou auto. Par défaut : auto.
description	Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.
input_fidelity	Le niveau de fidélité pour le traitement de l’image d’entrée.
input_image_mask	Masque facultatif pour l’inpainting. Contient image_url (chaîne, facultatif) et file_id (chaîne, facultatif).
model	Modèle à utiliser pour la génération d’images.
moderation	Niveau de modération de l’image générée. Par défaut : auto.
name	Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.
output_compression	Niveau de compression de l’image de sortie. Par défaut : 100.
output_format	Format de sortie de l’image générée. Valeurs possibles : png, webp ou jpeg. Par défaut : png.
partial_images	Nombre d’images partielles à générer en mode streaming, de 0 (valeur par défaut) à 3.
quality	Qualité de l’image générée. Un de low, medium, high, ou auto. Par défaut : auto.
size	Taille des images générées. Pour gpt-image-2 et gpt-image-2-2026-04-21, des résolutions arbitraires sont supportées sous forme WIDTHxHEIGHT de chaînes, par exemple 1536x864. La largeur et la hauteur doivent toutes deux être divisibles par 16 et le rapport d’aspect demandé doit être compris entre 1:3 et 3:1. Les résolutions ci-dessus 2560x1440 sont expérimentales, et la résolution maximale supportée est 3840x2160. La taille demandée doit également satisfaire aux limites actuelles de pixels et d’arêtes du modèle. Les tailles 1024x1024standard , 1536x1024, et 1024x1536 sont prises en charge par les modèles d’image GPT ; auto est pris en charge pour les modèles permettant le dimensionnement automatique. Pour dall-e-2, utilisez l’un des 256x256, 512x512, ou 1024x1024. Pour dall-e-3, utilisez l’un des 1024x1024, 1792x1024, ou 1024x1792.
tool_configs	Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.
type	Type de l’outil de génération d’images. A toujours la valeur image_generation.

Détails de la propriété

action

Que ce soit pour générer une nouvelle image ou modifier une image existante. Par défaut : auto.

action?: ImageGenAction

Valeur de propriété

ImageGenAction

background

Type d’arrière-plan pour l’image générée. Valeurs possibles : transparent, opaque ou auto. Par défaut : auto.

background?: "auto" | "transparent" | "opaque"

Valeur de propriété

"auto" | "transparent" | "opaque"

description

Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.

description?: string

Valeur de propriété

string

input_fidelity

Le niveau de fidélité pour le traitement de l’image d’entrée.

input_fidelity?: InputFidelity

Valeur de propriété

InputFidelity

input_image_mask

Masque facultatif pour l’inpainting. Contient image_url (chaîne, facultatif) et file_id (chaîne, facultatif).

input_image_mask?: ImageGenToolInputImageMask

Valeur de propriété

ImageGenToolInputImageMask

model

Modèle à utiliser pour la génération d’images.

model?: "gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5"

Valeur de propriété

"gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5"

moderation

Niveau de modération de l’image générée. Par défaut : auto.

moderation?: "auto" | "low"

Valeur de propriété

"auto" | "low"

name

Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.

name?: string

Valeur de propriété

string

output_compression

Niveau de compression de l’image de sortie. Par défaut : 100.

output_compression?: number

Valeur de propriété

number

output_format

Format de sortie de l’image générée. Valeurs possibles : png, webp ou jpeg. Par défaut : png.

output_format?: "png" | "webp" | "jpeg"

Valeur de propriété

"png" | "webp" | "jpeg"

partial_images

Nombre d’images partielles à générer en mode streaming, de 0 (valeur par défaut) à 3.

partial_images?: number

Valeur de propriété

number

quality

Qualité de l’image générée. Un de low, medium, high, ou auto. Par défaut : auto.

quality?: "auto" | "low" | "medium" | "high"

Valeur de propriété

"auto" | "low" | "medium" | "high"

size

Taille des images générées. Pour gpt-image-2 et gpt-image-2-2026-04-21, des résolutions arbitraires sont supportées sous forme WIDTHxHEIGHT de chaînes, par exemple 1536x864. La largeur et la hauteur doivent toutes deux être divisibles par 16 et le rapport d’aspect demandé doit être compris entre 1:3 et 3:1. Les résolutions ci-dessus 2560x1440 sont expérimentales, et la résolution maximale supportée est 3840x2160. La taille demandée doit également satisfaire aux limites actuelles de pixels et d’arêtes du modèle. Les tailles 1024x1024standard , 1536x1024, et 1024x1536 sont prises en charge par les modèles d’image GPT ; auto est pris en charge pour les modèles permettant le dimensionnement automatique. Pour dall-e-2, utilisez l’un des 256x256, 512x512, ou 1024x1024. Pour dall-e-3, utilisez l’un des 1024x1024, 1792x1024, ou 1024x1792.

size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024"

Valeur de propriété

"auto" | "1024x1024" | "1024x1536" | "1536x1024"

tool_configs

Deprecated. Cette propriété est dépréciée et sera supprimée dans une version ultérieure.

tool_configs?: Record<string, ToolConfig>

Valeur de propriété

Record<string, ToolConfig>

type

Type de l’outil de génération d’images. A toujours la valeur image_generation.

type: "image_generation"

Valeur de propriété

"image_generation"