Skip to content

OpenAIImageGenerationToolOptions

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIImageGenerationToolOptions

Options of ImageGeneration(OpenAIImageGenerationToolOptions). Maps to the upstream imageGeneration args.

Inheritance: object

View source

public string? Action { get; set; }

Whether to generate a new image or edit an existing one: generate, edit, or auto.

Value: string

View source

public string? Background { get; set; }

Background type: auto, opaque, or transparent.

Value: string

View source

public string? InputFidelity { get; set; }

Input fidelity: low or high.

Value: string

View source

public string? InputImageMaskFileId { get; set; }

File id of the inpainting mask.

Value: string

View source

public string? InputImageMaskImageUrl { get; set; }

Base64-encoded inpainting mask.

Value: string

View source

public string? Model { get; set; }

The image generation model. Default: gpt-image-1.

Value: string

View source

public string? Moderation { get; set; }

Moderation level: auto or low.

Value: string

View source

public int? OutputCompression { get; set; }

Compression level of the output image, 0 to 100.

Value: int?

View source

public string? OutputFormat { get; set; }

Output format: png, jpeg, or webp.

Value: string

View source

public int? PartialImages { get; set; }

Number of partial images in streaming mode, 0 to 3.

Value: int?

View source

public string? Quality { get; set; }

Quality: auto, low, medium, high, xhigh, or max.

Value: string

View source

public string? Size { get; set; }

Size: auto, 1024x1024, 1024x1536, 1536x1024, or WIDTHxHEIGHT.

Value: string

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product