Interface: ImageGenerationOptions<TProviderOptions, TSize>#
Defined in: packages/ai/src/types.ts:1805
Options for image generation. These are the common options supported across providers.
Type Parameters#
TProviderOptions#
TProviderOptions extends object = object
TSize#
TSize extends string | undefined = string
Properties#
logger#
logger: InternalLogger;
Defined in: packages/ai/src/types.ts:1831
Internal logger threaded from the generateImage() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.
model#
model: string;
Defined in: packages/ai/src/types.ts:1810
The model to use for image generation
modelOptions?#
optional modelOptions: TProviderOptions;
Defined in: packages/ai/src/types.ts:1826
Model-specific options for image generation
numberOfImages?#
optional numberOfImages: number;
Defined in: packages/ai/src/types.ts:1822
Number of images to generate (default: 1)
prompt#
prompt: MediaPrompt;
Defined in: packages/ai/src/types.ts:1820
Description of the desired image(s): a plain string, or an ordered array
of content parts for image-conditioned generation (image-to-image,
reference-guided, edit, multi-reference). Media parts may carry
metadata.role to disambiguate intent (mask, control, reference, …).
Adapters map parts onto the provider-native request — e.g. Gemini
multimodal contents, OpenAI images.edit(), fal image_url /
mask_url — and throw a clear runtime error for unsupported modalities.
size?#
optional size: TSize;
Defined in: packages/ai/src/types.ts:1824
Image size in WIDTHxHEIGHT format (e.g., "1024x1024")