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

ResolvedMediaPrompt.md

80 lines2.1 KB

1---
2id: ResolvedMediaPrompt
3title: ResolvedMediaPrompt
4---
5​
6# Interface: ResolvedMediaPrompt
7​
8Defined in: [packages/ai/src/utilities/media-prompt.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L23)
9​
10A [MediaPrompt](../type-aliases/MediaPrompt.md) decomposed into the views adapters consume.
11​
12Adapters with native multimodal prompts (Gemini `contents`, OpenRouter
13chat content parts) consume `parts` to preserve interleaving; named-field
14providers (fal, OpenAI) consume `text` plus the typed media buckets.
15​
16Prompt text is **never rewritten**: text parts are concatenated verbatim.
17Providers that support referencing inputs from the prompt (e.g. fal's
18`@Image1`, OpenAI's "image 1" prose) expect the user to write that syntax
19themselves — the SDK does not inject or substitute markers.
20​
21## Properties
22​
23### audios
24​
25```ts
26audios: AudioPart<MediaInputMetadata>[];
27```
28​
29Defined in: [packages/ai/src/utilities/media-prompt.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L36)
30​
31Audio parts in prompt order.
32​
33***
34​
35### images
36​
37```ts
38images: ImagePart<MediaInputMetadata>[];
39```
40​
41Defined in: [packages/ai/src/utilities/media-prompt.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L32)
42​
43Image parts in prompt order.
44​
45***
46​
47### parts
48​
49```ts
50parts: MediaPromptPart[];
51```
52​
53Defined in: [packages/ai/src/utilities/media-prompt.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L30)
54​
55The prompt as ordered parts; a string prompt becomes one text part.
56​
57***
58​
59### text
60​
61```ts
62text: string;
63```
64​
65Defined in: [packages/ai/src/utilities/media-prompt.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L28)
66​
67Text parts concatenated verbatim (paragraph-separated). Empty string
68for media-only prompts.
69​
70***
71​
72### videos
73​
74```ts
75videos: VideoPart<MediaInputMetadata>[];
76```
77​
78Defined in: [packages/ai/src/utilities/media-prompt.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L34)
79​
80Video parts in prompt order.