Skip to content

ImageGenerationOptions.md

Latest commit

 

History

History
94 lines (56 loc) · 2.01 KB

ImageGenerationOptions.md

File metadata and controls

94 lines (56 loc) · 2.01 KB
id ImageGenerationOptions
title ImageGenerationOptions

Interface: ImageGenerationOptions<TProviderOptions, TSize>

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

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;

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

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/typescript/ai/src/types.ts:1206

The model to use for image generation

modelOptions?

optional modelOptions: TProviderOptions;

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

Model-specific options for image generation

numberOfImages?

optional numberOfImages: number;

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

Number of images to generate (default: 1)

prompt

prompt: string;

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

Text description of the desired image(s)

size?

optional size: TSize;

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

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