Open History to see the last commit
1---
2id: ImageAdapter
3title: ImageAdapter
4---
5
6# Interface: ImageAdapter\<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName, TModelInputModalitiesByName\>
7
8Defined in: [packages/ai/src/activities/generateImage/adapter.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L39)
9
10Image adapter interface with pre-resolved generics.
11
12An adapter is created by a provider function: `provider('model')` → `adapter`
13All type resolution happens at the provider call site, not in this interface.
14
15Generic parameters:
16- TModel: The specific model name (e.g., 'dall-e-3')
17- TProviderOptions: Base provider-specific options (already resolved)
18- TModelProviderOptionsByName: Map from model name to its specific provider options
19- TModelSizeByName: Map from model name to its supported sizes
20- TModelInputModalitiesByName: Map from model name to the non-text prompt
21 modalities it accepts (constrains the `prompt` part types at compile time)
22
23## Type Parameters
24
25### TModel
26
27`TModel` *extends* `string` = `string`
28
29### TProviderOptions
30
31`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
32
33### TModelProviderOptionsByName
34
35`TModelProviderOptionsByName` *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\>
36
37### TModelSizeByName
38
39`TModelSizeByName` *extends* `Record`\<`string`, `string` \| `undefined`\> = `Record`\<`string`, `string`\>
40
41### TModelInputModalitiesByName
42
43`TModelInputModalitiesByName` *extends* [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md) = [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md)
44
45## Properties
46
47### ~types
48
49```ts
50~types: object;
51```
52
53Defined in: [packages/ai/src/activities/generateImage/adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L60)
54
55**`Internal`**
56
57Type-only properties for inference. Not assigned at runtime.
58
59#### modelInputModalitiesByName
60
61```ts
62modelInputModalitiesByName: TModelInputModalitiesByName;
63```
64
65#### modelProviderOptionsByName
66
67```ts
68modelProviderOptionsByName: TModelProviderOptionsByName;
69```
70
71#### modelSizeByName
72
73```ts
74modelSizeByName: TModelSizeByName;
75```
76
77#### providerOptions
78
79```ts
80providerOptions: TProviderOptions;
81```
82
83***
84
85### generateImages()
86
87```ts
88generateImages: (options) => Promise<ImageGenerationResult>;
89```
90
91Defined in: [packages/ai/src/activities/generateImage/adapter.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L70)
92
93Generate images from a prompt
94
95#### Parameters
96
97##### options
98
99[`ImageGenerationOptions`](ImageGenerationOptions.md)\<`TProviderOptions`, `TModelSizeByName`\[`TModel`\]\>
100
101#### Returns
102
103`Promise`\<[`ImageGenerationResult`](ImageGenerationResult.md)\>
104
105***
106
107### kind
108
109```ts
110readonly kind: "image";
111```
112
113Defined in: [packages/ai/src/activities/generateImage/adapter.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L51)
114
115Discriminator for adapter kind - used by generate() to determine API shape
116
117***
118
119### model
120
121```ts
122readonly model: TModel;
123```
124
125Defined in: [packages/ai/src/activities/generateImage/adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L55)
126
127The model this adapter is configured for
128
129***
130
131### name
132
133```ts
134readonly name: string;
135```
136
137Defined in: [packages/ai/src/activities/generateImage/adapter.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L53)
138
139Adapter name identifier