ImageGenTool interface

Pacote:

@azure/ai-projects

Uma ferramenta que gera imagens usando os modelos de imagem GPT.

Extends

Tool

Propriedades

action	Se é para gerar uma nova imagem ou editar uma imagem existente. Padrão: auto.
background	Tipo de plano de fundo para a imagem gerada. Uma opção entre transparent, opaque ou auto. Padrão: auto.
description	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
input_fidelity	O nível de fidelidade para processamento de imagens de entrada.
input_image_mask	Máscara opcional para inpainting. Contém image_url (cadeia de caracteres, opcional) e file_id (cadeia de caracteres, opcional).
model	O modelo a ser usado para geração de imagem.
moderation	Nível de moderação para a imagem gerada. Padrão: auto.
name	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
output_compression	Nível de compactação para a imagem de saída. Padrão: 100.
output_format	O formato de saída da imagem gerada. Uma opção entre png, webp ou jpeg. Padrão: png.
partial_images	Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3.
quality	A qualidade da imagem gerada. Uma opção entre low, medium, high ou auto. Padrão: auto.
size	O tamanho das imagens geradas. Para gpt-image-2 e gpt-image-2-2026-04-21, resoluções arbitrárias são suportadas como WIDTHxHEIGHT cadeias, por exemplo 1536x864. Largura e altura devem ser ambas divisíveis por 16 e a proporção solicitada deve estar entre 1:3 e 3:1. As resoluções acima 2560x1440 são experimentais, e a resolução máxima suportada é 3840x2160. O tamanho solicitado também deve atender aos limites atuais de pixels e bordas do modelo. Os tamanhos 1024x1024padrão , 1536x1024, e 1024x1536 são suportados pelos modelos de imagem GPT; auto é suportado para modelos que permitem dimensionamento automático. Para dall-e-2, use um dos 256x256, 512x512, ou 1024x1024. Para dall-e-3, use um dos 1024x1024, 1792x1024, ou 1024x1792.
tool_configs	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
type	O tipo da ferramenta de geração de imagem. Sempre image_generation.

Detalhes da propriedade

action

Se é para gerar uma nova imagem ou editar uma imagem existente. Padrão: auto.

action?: ImageGenAction

Valor da propriedade

ImageGenAction

background

Tipo de plano de fundo para a imagem gerada. Uma opção entre transparent, opaque ou auto. Padrão: auto.

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

Valor da propriedade

"auto" | "transparent" | "opaque"

description

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

description?: string

Valor da propriedade

string

input_fidelity

O nível de fidelidade para processamento de imagens de entrada.

input_fidelity?: InputFidelity

Valor da propriedade

InputFidelity

input_image_mask

Máscara opcional para inpainting. Contém image_url (cadeia de caracteres, opcional) e file_id (cadeia de caracteres, opcional).

input_image_mask?: ImageGenToolInputImageMask

Valor da propriedade

ImageGenToolInputImageMask

model

O modelo a ser usado para geração de imagem.

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

Valor da propriedade

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

moderation

Nível de moderação para a imagem gerada. Padrão: auto.

moderation?: "auto" | "low"

Valor da propriedade

"auto" | "low"

name

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

name?: string

Valor da propriedade

string

output_compression

Nível de compactação para a imagem de saída. Padrão: 100.

output_compression?: number

Valor da propriedade

number

output_format

O formato de saída da imagem gerada. Uma opção entre png, webp ou jpeg. Padrão: png.

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

Valor da propriedade

"png" | "webp" | "jpeg"

partial_images

Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3.

partial_images?: number

Valor da propriedade

number

quality

A qualidade da imagem gerada. Uma opção entre low, medium, high ou auto. Padrão: auto.

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

Valor da propriedade

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

size

O tamanho das imagens geradas. Para gpt-image-2 e gpt-image-2-2026-04-21, resoluções arbitrárias são suportadas como WIDTHxHEIGHT cadeias, por exemplo 1536x864. Largura e altura devem ser ambas divisíveis por 16 e a proporção solicitada deve estar entre 1:3 e 3:1. As resoluções acima 2560x1440 são experimentais, e a resolução máxima suportada é 3840x2160. O tamanho solicitado também deve atender aos limites atuais de pixels e bordas do modelo. Os tamanhos 1024x1024padrão , 1536x1024, e 1024x1536 são suportados pelos modelos de imagem GPT; auto é suportado para modelos que permitem dimensionamento automático. Para dall-e-2, use um dos 256x256, 512x512, ou 1024x1024. Para dall-e-3, use um dos 1024x1024, 1792x1024, ou 1024x1792.

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

Valor da propriedade

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

tool_configs

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

tool_configs?: Record<string, ToolConfig>

Valor da propriedade

Record<string, ToolConfig>

type

O tipo da ferramenta de geração de imagem. Sempre image_generation.

type: "image_generation"

Valor da propriedade

"image_generation"