ImageGenTool interface

Пакет:

@azure/ai-projects

Инструмент, который генерирует изображения с использованием моделей GPT.

Extends

Tool

Свойства

action	Создавать ли новое изображение или редактировать существующее. По умолчанию: auto.
background	Тип фона для созданного изображения. Один из transparent, opaque, или auto. По умолчанию: auto.
description	Устарело. Это свойство устарело и будет удалено в будущей версии.
input_fidelity	Уровень точности для обработки входных изображений.
input_image_mask	Опциональная маска для инпейнтинга. Содержит image_url (строка, необязательно) и file_id (строка, необязательно).
model	Модель, используемая для создания изображений.
moderation	Уровень модерации для созданного образа. По умолчанию: auto.
name	Устарело. Это свойство устарело и будет удалено в будущей версии.
output_compression	Уровень сжатия для выходного изображения. Значение по умолчанию: 100.
output_format	Формат выходных данных созданного изображения. Один из png, webp, или jpeg. По умолчанию: png.
partial_images	Количество частичных образов для создания в режиме потоковой передачи от 0 (значение по умолчанию) до 3.
quality	Качество созданного изображения. Один из low, mediumhighили auto. По умолчанию: auto.
size	Размер сгенерированных изображений. Для gpt-image-2 и gpt-image-2-2026-04-21, произвольные разрешения поддерживаются в виде WIDTHxHEIGHT строк, например 1536x864. Ширина и высота должны делиться на 16, а запрашиваемое соотношение сторон — от 1:3 до 3:1. Вышеуказанные 2560x1440 разрешения являются экспериментальными, и максимальное поддерживаемое разрешение — 3840x2160. Запрашиваемый размер также должен удовлетворять текущим ограничениям по пикселям и краям модели. Стандартные размеры 1024x1024, 1536x1024, и 1024x1536 поддерживаются моделями auto GPT; поддерживаются для моделей с автоматическим подбором размера. Для dall-e-2, используйте одно из 256x256, 512x512, или 1024x1024. Для dall-e-3, используйте одно из 1024x1024, 1792x1024, или 1024x1792.
tool_configs	Устарело. Это свойство устарело и будет удалено в будущей версии.
type	Тип средства создания изображений. Всегда image_generation.

Сведения о свойстве

action

Создавать ли новое изображение или редактировать существующее. По умолчанию: auto.

action?: ImageGenAction

Значение свойства

ImageGenAction

background

Тип фона для созданного изображения. Один из transparent, opaque, или auto. По умолчанию: auto.

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

Значение свойства

"auto" | "transparent" | "opaque"

description

Устарело. Это свойство устарело и будет удалено в будущей версии.

description?: string

Значение свойства

string

input_fidelity

Уровень точности для обработки входных изображений.

input_fidelity?: InputFidelity

Значение свойства

InputFidelity

input_image_mask

Опциональная маска для инпейнтинга. Содержит image_url (строка, необязательно) и file_id (строка, необязательно).

input_image_mask?: ImageGenToolInputImageMask

Значение свойства

ImageGenToolInputImageMask

model

Модель, используемая для создания изображений.

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

Значение свойства

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

moderation

Уровень модерации для созданного образа. По умолчанию: auto.

moderation?: "auto" | "low"

Значение свойства

"auto" | "low"

name

Устарело. Это свойство устарело и будет удалено в будущей версии.

name?: string

Значение свойства

string

output_compression

Уровень сжатия для выходного изображения. Значение по умолчанию: 100.

output_compression?: number

Значение свойства

number

output_format

Формат выходных данных созданного изображения. Один из png, webp, или jpeg. По умолчанию: png.

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

Значение свойства

"png" | "webp" | "jpeg"

partial_images

Количество частичных образов для создания в режиме потоковой передачи от 0 (значение по умолчанию) до 3.

partial_images?: number

Значение свойства

number

quality

Качество созданного изображения. Один из low, mediumhighили auto. По умолчанию: auto.

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

Значение свойства

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

size

Размер сгенерированных изображений. Для gpt-image-2 и gpt-image-2-2026-04-21, произвольные разрешения поддерживаются в виде WIDTHxHEIGHT строк, например 1536x864. Ширина и высота должны делиться на 16, а запрашиваемое соотношение сторон — от 1:3 до 3:1. Вышеуказанные 2560x1440 разрешения являются экспериментальными, и максимальное поддерживаемое разрешение — 3840x2160. Запрашиваемый размер также должен удовлетворять текущим ограничениям по пикселям и краям модели. Стандартные размеры 1024x1024, 1536x1024, и 1024x1536 поддерживаются моделями auto GPT; поддерживаются для моделей с автоматическим подбором размера. Для dall-e-2, используйте одно из 256x256, 512x512, или 1024x1024. Для dall-e-3, используйте одно из 1024x1024, 1792x1024, или 1024x1792.

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

Значение свойства

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

tool_configs

Устарело. Это свойство устарело и будет удалено в будущей версии.

tool_configs?: Record<string, ToolConfig>

Значение свойства

Record<string, ToolConfig>

type

Тип средства создания изображений. Всегда image_generation.

type: "image_generation"

Значение свойства

"image_generation"