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

ImagePart.md

52 lines981 Bytes

1---
2id: ImagePart
3title: ImagePart
4---
5​
6# Interface: ImagePart\<TMetadata\>
7​
8Defined in: [packages/ai/src/types.ts:248](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L248)
9​
10Image content part for multimodal messages.
11​
12## Type Parameters
13​
14### TMetadata
15​
16`TMetadata` = `unknown`
17​
18Provider-specific metadata type (e.g., OpenAI's detail level)
19​
20## Properties
21​
22### metadata?
23​
24```ts
25optional metadata: TMetadata;
26```
27​
28Defined in: [packages/ai/src/types.ts:253](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L253)
29​
30Provider-specific metadata (e.g., OpenAI's detail: 'auto' | 'low' | 'high')
31​
32***
33​
34### source
35​
36```ts
37source: ContentPartSource;
38```
39​
40Defined in: [packages/ai/src/types.ts:251](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L251)
41​
42Source of the image content
43​
44***
45​
46### type
47​
48```ts
49type: "image";
50```
51​
52Defined in: [packages/ai/src/types.ts:249](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L249)