Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ImageGenerationOptions.md

94 lines2.0 KB

Interface: ImageGenerationOptions<TProviderOptions, TSize>

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

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

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:1421

The model to use for image generation


modelOptions?

optional modelOptions: TProviderOptions;

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

Model-specific options for image generation


numberOfImages?

optional numberOfImages: number;

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

Number of images to generate (default: 1)


prompt

prompt: string;

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

Text description of the desired image(s)


size?

optional size: TSize;

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

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