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

ToolCallStreamChunk.md

118 lines1.8 KB

1---
2id: ToolCallStreamChunk
3title: ToolCallStreamChunk
4---
5​
6# Interface: ToolCallStreamChunk
7​
8Defined in: [types.ts:655](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L655)
9​
10## Extends
11​
12- [`BaseStreamChunk`](BaseStreamChunk.md)
13​
14## Properties
15​
16### id
17​
18```ts
19id: string;
20```
21​
22Defined in: [types.ts:643](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L643)
23​
24#### Inherited from
25​
26[`BaseStreamChunk`](BaseStreamChunk.md).[`id`](BaseStreamChunk.md#id)
27​
28***
29​
30### index
31​
32```ts
33index: number;
34```
35​
36Defined in: [types.ts:665](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L665)
37​
38***
39​
40### model
41​
42```ts
43model: string;
44```
45​
46Defined in: [types.ts:644](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L644)
47​
48#### Inherited from
49​
50[`BaseStreamChunk`](BaseStreamChunk.md).[`model`](BaseStreamChunk.md#model)
51​
52***
53​
54### timestamp
55​
56```ts
57timestamp: number;
58```
59​
60Defined in: [types.ts:645](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L645)
61​
62#### Inherited from
63​
64[`BaseStreamChunk`](BaseStreamChunk.md).[`timestamp`](BaseStreamChunk.md#timestamp)
65​
66***
67​
68### toolCall
69​
70```ts
71toolCall: object;
72```
73​
74Defined in: [types.ts:657](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L657)
75​
76#### function
77​
78```ts
79function: object;
80```
81​
82##### function.arguments
83​
84```ts
85arguments: string;
86```
87​
88##### function.name
89​
90```ts
91name: string;
92```
93​
94#### id
95​
96```ts
97id: string;
98```
99​
100#### type
101​
102```ts
103type: "function";
104```
105​
106***
107​
108### type
109​
110```ts
111type: "tool_call";
112```
113​
114Defined in: [types.ts:656](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L656)
115​
116#### Overrides
117​
118[`BaseStreamChunk`](BaseStreamChunk.md).[`type`](BaseStreamChunk.md#type)