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

generateImage.md

75 lines1.5 KB

1---
2id: generateImage
3title: generateImage
4---
5​
6# Function: generateImage()
7​
8```ts
9function generateImage<TAdapter, TStream>(options): ImageActivityResult<TStream>;
10```
11​
12Defined in: [packages/typescript/ai/src/activities/generateImage/index.ts:176](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L176)
13​
14Image activity - generates images from text prompts.
15​
16Uses AI image generation models to create images based on natural language descriptions.
17​
18## Type Parameters
19​
20### TAdapter
21​
22`TAdapter` *extends* [`ImageAdapter`](../interfaces/ImageAdapter.md)\<`string`, `any`, `any`, `any`\>
23​
24### TStream
25​
26`TStream` *extends* `boolean` = `false`
27​
28## Parameters
29​
30### options
31​
32`ImageActivityOptions`\<`TAdapter`, `TStream`\>
33​
34## Returns
35​
36`ImageActivityResult`\<`TStream`\>
37​
38## Examples
39​
40```ts
41import { generateImage } from '@tanstack/ai'
42import { openaiImage } from '@tanstack/ai-openai'
43​
44const result = await generateImage({
45 adapter: openaiImage('dall-e-3'),
46 prompt: 'A serene mountain landscape at sunset'
47})
48​
49console.log(result.images[0].url)
50```
51​
52```ts
53const result = await generateImage({
54 adapter: openaiImage('dall-e-2'),
55 prompt: 'A cute robot mascot',
56 numberOfImages: 4,
57 size: '512x512'
58})
59​
60result.images.forEach((image, i) => {
61 console.log(`Image ${i + 1}: ${image.url}`)
62})
63```
64​
65```ts
66const result = await generateImage({
67 adapter: openaiImage('dall-e-3'),
68 prompt: 'A professional headshot photo',
69 size: '1024x1024',
70 modelOptions: {
71 quality: 'hd',
72 style: 'natural'
73 }
74})
75```