ImageGenTool interface

Paket:

@azure/ai-projects

Ein Tool, das Bilder mithilfe der GPT-Bildmodelle generiert.

Extends

Tool

Eigenschaften

action	Ob ein neues Bild generiert oder ein bestehendes Bild bearbeitet wird. Standardwert: auto.
background	Hintergrundtyp für das generierte Bild. Einer der folgenden Werte: transparent, opaque oder auto. Standardwert: auto.
description	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
input_fidelity	Das Treueniveau für die Eingabebildverarbeitung.
input_image_mask	Optionale Maske für die Bildbearbeitung. Enthält image_url (Zeichenfolge, optional) und file_id (Zeichenfolge, optional).
model	Das Modell, das für die Bildgenerierung verwendet werden soll.
moderation	Moderationsebene für das generierte Bild. Standardwert: auto.
name	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
output_compression	Komprimierungsebene für das Ausgabebild. Standardwert: 100.
output_format	Das Ausgabeformat des generierten Bilds. Einer der folgenden Werte: png, webp oder jpeg. Standardwert: png.
partial_images	Anzahl der Teilbilder, die im Streamingmodus generiert werden sollen, von 0 (Standardwert) bis 3.
quality	Die Qualität des generierten Bilds. Einer der folgenden Werte: low, medium, high oder auto. Standardwert: auto.
size	Die Größe der generierten Bilder. Für gpt-image-2 und gpt-image-2-2026-04-21werden beliebige Resolutionen als WIDTHxHEIGHT Strings unterstützt, zum Beispiel 1536x864. Breite und Höhe müssen beide durch 16 teilbar sein, und das gewünschte Seitenverhältnis muss zwischen 1:3 und 3:1 liegen. Die oben genannten 2560x1440 Auflösungen sind experimentell, und die maximal unterstützte Auflösung ist 3840x2160. Die gewünschte Größe muss außerdem die aktuellen Pixel- und Kantengrenzen des Modells erfüllen. Die Standardgrößen 1024x1024, 1536x1024, und 1024x1536 werden von den GPT-Bildmodellen unterstützt; auto wird für Modelle unterstützt, die automatische Größenzuordnung erlauben. Für dall-e-2, verwende eines von 256x256, 512x512, oder 1024x1024. Für dall-e-3, verwende eines von 1024x1024, 1792x1024, oder 1024x1792.
tool_configs	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
type	Der Typ des Tools zur Bildgenerierung. Immer image_generation.

Details zur Eigenschaft

action

Ob ein neues Bild generiert oder ein bestehendes Bild bearbeitet wird. Standardwert: auto.

action?: ImageGenAction

Eigenschaftswert

ImageGenAction

background

Hintergrundtyp für das generierte Bild. Einer der folgenden Werte: transparent, opaque oder auto. Standardwert: auto.

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

Eigenschaftswert

"auto" | "transparent" | "opaque"

description

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

description?: string

Eigenschaftswert

string

input_fidelity

Das Treueniveau für die Eingabebildverarbeitung.

input_fidelity?: InputFidelity

Eigenschaftswert

InputFidelity

input_image_mask

Optionale Maske für die Bildbearbeitung. Enthält image_url (Zeichenfolge, optional) und file_id (Zeichenfolge, optional).

input_image_mask?: ImageGenToolInputImageMask

Eigenschaftswert

ImageGenToolInputImageMask

model

Das Modell, das für die Bildgenerierung verwendet werden soll.

model?: "gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5" | "gpt-image-2" | "gpt-image-2-2026-04-21"

Eigenschaftswert

"gpt-image-1" | "gpt-image-1-mini" | "gpt-image-1.5" | "gpt-image-2" | "gpt-image-2-2026-04-21"

moderation

Moderationsebene für das generierte Bild. Standardwert: auto.

moderation?: "auto" | "low"

Eigenschaftswert

"auto" | "low"

name

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

name?: string

Eigenschaftswert

string

output_compression

Komprimierungsebene für das Ausgabebild. Standardwert: 100.

output_compression?: number

Eigenschaftswert

number

output_format

Das Ausgabeformat des generierten Bilds. Einer der folgenden Werte: png, webp oder jpeg. Standardwert: png.

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

Eigenschaftswert

"png" | "webp" | "jpeg"

partial_images

Anzahl der Teilbilder, die im Streamingmodus generiert werden sollen, von 0 (Standardwert) bis 3.

partial_images?: number

Eigenschaftswert

number

quality

Die Qualität des generierten Bilds. Einer der folgenden Werte: low, medium, high oder auto. Standardwert: auto.

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

Eigenschaftswert

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

size

Die Größe der generierten Bilder. Für gpt-image-2 und gpt-image-2-2026-04-21werden beliebige Resolutionen als WIDTHxHEIGHT Strings unterstützt, zum Beispiel 1536x864. Breite und Höhe müssen beide durch 16 teilbar sein, und das gewünschte Seitenverhältnis muss zwischen 1:3 und 3:1 liegen. Die oben genannten 2560x1440 Auflösungen sind experimentell, und die maximal unterstützte Auflösung ist 3840x2160. Die gewünschte Größe muss außerdem die aktuellen Pixel- und Kantengrenzen des Modells erfüllen. Die Standardgrößen 1024x1024, 1536x1024, und 1024x1536 werden von den GPT-Bildmodellen unterstützt; auto wird für Modelle unterstützt, die automatische Größenzuordnung erlauben. Für dall-e-2, verwende eines von 256x256, 512x512, oder 1024x1024. Für dall-e-3, verwende eines von 1024x1024, 1792x1024, oder 1024x1792.

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

Eigenschaftswert

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

tool_configs

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

tool_configs?: Record<string, ToolConfig>

Eigenschaftswert

Record<string, ToolConfig>

type

Der Typ des Tools zur Bildgenerierung. Immer image_generation.

type: "image_generation"

Eigenschaftswert

"image_generation"