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

ImageAdapter.md

127 lines3.2 KB

1---
2id: ImageAdapter
3title: ImageAdapter
4---
5​
6# Interface: ImageAdapter\<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName\>
7​
8Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L33)
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​
21## Type Parameters
22​
23### TModel
24​
25`TModel` *extends* `string` = `string`
26​
27### TProviderOptions
28​
29`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
30​
31### TModelProviderOptionsByName
32​
33`TModelProviderOptionsByName` *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\>
34​
35### TModelSizeByName
36​
37`TModelSizeByName` *extends* `Record`\<`string`, `string` \| `undefined`\> = `Record`\<`string`, `string`\>
38​
39## Properties
40​
41### ~types
42​
43```ts
44~types: object;
45```
46​
47Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:52](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L52)
48​
49**`Internal`**
50​
51Type-only properties for inference. Not assigned at runtime.
52​
53#### modelProviderOptionsByName
54​
55```ts
56modelProviderOptionsByName: TModelProviderOptionsByName;
57```
58​
59#### modelSizeByName
60​
61```ts
62modelSizeByName: TModelSizeByName;
63```
64​
65#### providerOptions
66​
67```ts
68providerOptions: TProviderOptions;
69```
70​
71***
72​
73### generateImages()
74​
75```ts
76generateImages: (options) => Promise<ImageGenerationResult>;
77```
78​
79Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:61](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L61)
80​
81Generate images from a prompt
82​
83#### Parameters
84​
85##### options
86​
87[`ImageGenerationOptions`](ImageGenerationOptions.md)\<`TProviderOptions`, `TModelSizeByName`\[`TModel`\]\>
88​
89#### Returns
90​
91`Promise`\<[`ImageGenerationResult`](ImageGenerationResult.md)\>
92​
93***
94​
95### kind
96​
97```ts
98readonly kind: "image";
99```
100​
101Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:43](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L43)
102​
103Discriminator for adapter kind - used by generate() to determine API shape
104​
105***
106​
107### model
108​
109```ts
110readonly model: TModel;
111```
112​
113Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:47](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L47)
114​
115The model this adapter is configured for
116​
117***
118​
119### name
120​
121```ts
122readonly name: string;
123```
124​
125Defined in: [packages/typescript/ai/src/activities/generateImage/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/adapter.ts#L45)
126​
127Adapter name identifier