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

ImageGenerationOptions.md

100 lines2.3 KB

1---
2id: ImageGenerationOptions
3title: ImageGenerationOptions
4---
5​
6# Interface: ImageGenerationOptions\<TProviderOptions, TSize\>
7​
8Defined in: [packages/ai/src/types.ts:1805](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1805)
9​
10Options for image generation.
11These are the common options supported across providers.
12​
13## Type Parameters
14​
15### TProviderOptions
16​
17`TProviderOptions` *extends* `object` = `object`
18​
19### TSize
20​
21`TSize` *extends* `string` \| `undefined` = `string`
22​
23## Properties
24​
25### logger
26​
27```ts
28logger: InternalLogger;
29```
30​
31Defined in: [packages/ai/src/types.ts:1831](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1831)
32​
33Internal logger threaded from the generateImage() entry point. Adapters must
34call logger.request() before the SDK call and logger.errors() in catch blocks.
35​
36***
37​
38### model
39​
40```ts
41model: string;
42```
43​
44Defined in: [packages/ai/src/types.ts:1810](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1810)
45​
46The model to use for image generation
47​
48***
49​
50### modelOptions?
51​
52```ts
53optional modelOptions: TProviderOptions;
54```
55​
56Defined in: [packages/ai/src/types.ts:1826](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1826)
57​
58Model-specific options for image generation
59​
60***
61​
62### numberOfImages?
63​
64```ts
65optional numberOfImages: number;
66```
67​
68Defined in: [packages/ai/src/types.ts:1822](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1822)
69​
70Number of images to generate (default: 1)
71​
72***
73​
74### prompt
75​
76```ts
77prompt: MediaPrompt;
78```
79​
80Defined in: [packages/ai/src/types.ts:1820](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1820)
81​
82Description of the desired image(s): a plain string, or an ordered array
83of content parts for image-conditioned generation (image-to-image,
84reference-guided, edit, multi-reference). Media parts may carry
85`metadata.role` to disambiguate intent (mask, control, reference, …).
86Adapters map parts onto the provider-native request — e.g. Gemini
87multimodal `contents`, OpenAI `images.edit()`, fal `image_url` /
88`mask_url` — and throw a clear runtime error for unsupported modalities.
89​
90***
91​
92### size?
93​
94```ts
95optional size: TSize;
96```
97​
98Defined in: [packages/ai/src/types.ts:1824](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1824)
99​
100Image size in WIDTHxHEIGHT format (e.g., "1024x1024")