Interface: ImageGenerationOptions<TProviderOptions, TSize>#

Defined in: packages/typescript/ai/src/types.ts:1206

Options for image generation. These are the common options supported across providers.

Type Parameters#

TProviderOptions#

TProviderOptions extends object = object

TSize#

TSize extends string = string

Properties#

logger#

logger: InternalLogger;

logger: InternalLogger;

Defined in: packages/typescript/ai/src/types.ts:1224

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;

model: string;

Defined in: packages/typescript/ai/src/types.ts:1211

The model to use for image generation

modelOptions?#

optional modelOptions: TProviderOptions;

optional modelOptions: TProviderOptions;

Defined in: packages/typescript/ai/src/types.ts:1219

Model-specific options for image generation

numberOfImages?#

optional numberOfImages: number;

optional numberOfImages: number;

Defined in: packages/typescript/ai/src/types.ts:1215

Number of images to generate (default: 1)

prompt#

prompt: string;

prompt: string;

Defined in: packages/typescript/ai/src/types.ts:1213

Text description of the desired image(s)

size?#

optional size: TSize;

optional size: TSize;

Defined in: packages/typescript/ai/src/types.ts:1217

Image size in WIDTHxHEIGHT format (e.g., "1024x1024")