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

ImageGenerationOptions.md

77 lines1.4 KB

1---
2id: ImageGenerationOptions
3title: ImageGenerationOptions
4---
5​
6# Interface: ImageGenerationOptions\<TProviderOptions\>
7​
8Defined in: [types.ts:771](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L771)
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## Properties
20​
21### model
22​
23```ts
24model: string;
25```
26​
27Defined in: [types.ts:775](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L775)
28​
29The model to use for image generation
30​
31***
32​
33### modelOptions?
34​
35```ts
36optional modelOptions: TProviderOptions;
37```
38​
39Defined in: [types.ts:783](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L783)
40​
41Model-specific options for image generation
42​
43***
44​
45### numberOfImages?
46​
47```ts
48optional numberOfImages: number;
49```
50​
51Defined in: [types.ts:779](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L779)
52​
53Number of images to generate (default: 1)
54​
55***
56​
57### prompt
58​
59```ts
60prompt: string;
61```
62​
63Defined in: [types.ts:777](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L777)
64​
65Text description of the desired image(s)
66​
67***
68​
69### size?
70​
71```ts
72optional size: string;
73```
74​
75Defined in: [types.ts:781](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L781)
76​
77Image size in WIDTHxHEIGHT format (e.g., "1024x1024")