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

InternalToolCallState.md

85 lines2.2 KB

1---
2id: InternalToolCallState
3title: InternalToolCallState
4---
5​
6# Interface: InternalToolCallState
7​
8Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:21](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L21)
9​
10Internal state for a tool call being tracked
11​
12## Properties
13​
14### arguments
15​
16```ts
17arguments: string;
18```
19​
20Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:24](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L24)
21​
22***
23​
24### id
25​
26```ts
27id: string;
28```
29​
30Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:22](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L22)
31​
32***
33​
34### index
35​
36```ts
37index: number;
38```
39​
40Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:27](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L27)
41​
42***
43​
44### metadata?
45​
46```ts
47optional metadata: Record<string, unknown>;
48```
49​
50Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:32](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L32)
51​
52Provider-specific metadata that round-trips with the tool call
53(e.g. Gemini's `thoughtSignature`). Untyped at this layer because
54the stream processor is provider-agnostic; adapters narrow it
55via their `TToolCallMetadata` generic.
56​
57***
58​
59### name
60​
61```ts
62name: string;
63```
64​
65Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:23](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L23)
66​
67***
68​
69### parsedArguments?
70​
71```ts
72optional parsedArguments: any;
73```
74​
75Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:26](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L26)
76​
77***
78​
79### state
80​
81```ts
82state: ToolCallState;
83```
84​
85Defined in: [packages/typescript/ai/src/activities/chat/stream/types.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/types.ts#L25)