ImageGenTool interface

パッケージ:

@azure/ai-projects

GPTの画像モデルを使って画像を生成するツールです。

Extends

Tool

プロパティ

action	新しい画像を生成するか、既存の画像を編集するか。 既定値: auto。
background	生成されたイメージの背景の種類。 transparent、opaque、または auto のいずれか。 既定値: auto。
description	Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。
input_fidelity	入力画像処理の忠実度レベル。
input_image_mask	インペインティング用のオプションのマスク。 image_url (文字列、省略可能) とfile_id (文字列、省略可能) を格納します。
model	イメージの生成に使用するモデル。
moderation	生成されたイメージのモデレーション レベル。 既定値: auto。
name	Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。
output_compression	出力イメージの圧縮レベル。 既定値: 100。
output_format	生成されたイメージの出力形式。 png、webp、または jpeg のいずれか。 既定値: png。
partial_images	ストリーミング モードで生成する部分イメージの数 。0 (既定値) から 3。
quality	生成されたイメージの品質。 low、medium、high、または auto のいずれかです。 既定値: auto。
size	生成される画像のサイズ。 gpt-image-2およびgpt-image-2-2026-04-21では、任意の解決は例えば1536x864などの WIDTHxHEIGHT 文字列としてサポートされています。 幅と高さはどちらも16で割り切れ、要求されるアスペクト比は1:3から3:1の間でなければなりません。 2560x1440以上の解像度は実験的であり、最大サポート解像度は3840x2160です。 要求されたサイズは、モデルの現在のピクセルおよびエッジの制限も満たさなければなりません。 標準サイズ 1024x1024、 1536x1024、 1024x1536 はGPT画像モデルでサポートされています。 auto は自動サイズ設定を可能にするモデルにも対応しています。 dall-e-2には、256x256、512x512、または1024x1024のいずれかを使いましょう。 dall-e-3には、1024x1024、1792x1024、または1024x1792のいずれかを使いましょう。
tool_configs	Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。
type	イメージ生成ツールの種類。 常に image_generation です。

プロパティの詳細

action

新しい画像を生成するか、既存の画像を編集するか。 既定値: auto。

action?: ImageGenAction

プロパティ値

ImageGenAction

background

生成されたイメージの背景の種類。 transparent、opaque、または auto のいずれか。 既定値: auto。

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

プロパティ値

"auto" | "transparent" | "opaque"

description

Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。

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

Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。

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、medium、high、または auto のいずれかです。 既定値: auto。

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

プロパティ値

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

size

生成される画像のサイズ。 gpt-image-2およびgpt-image-2-2026-04-21では、任意の解決は例えば1536x864などの WIDTHxHEIGHT 文字列としてサポートされています。 幅と高さはどちらも16で割り切れ、要求されるアスペクト比は1:3から3:1の間でなければなりません。 2560x1440以上の解像度は実験的であり、最大サポート解像度は3840x2160です。 要求されたサイズは、モデルの現在のピクセルおよびエッジの制限も満たさなければなりません。 標準サイズ 1024x1024、 1536x1024、 1024x1536 はGPT画像モデルでサポートされています。 auto は自動サイズ設定を可能にするモデルにも対応しています。 dall-e-2には、256x256、512x512、または1024x1024のいずれかを使いましょう。 dall-e-3には、1024x1024、1792x1024、または1024x1792のいずれかを使いましょう。

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

プロパティ値

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

tool_configs

Deprecated. このプロパティは現在非推奨となり、将来のバージョンで削除される予定です。

tool_configs?: Record<string, ToolConfig>

プロパティ値

Record<string, ToolConfig>

type

イメージ生成ツールの種類。 常に image_generation です。

type: "image_generation"

プロパティ値

"image_generation"