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

ToolCallEndEvent.md

100 lines1.8 KB

1---
2id: ToolCallEndEvent
3title: ToolCallEndEvent
4---
5​
6# Interface: ToolCallEndEvent
7​
8Defined in: [packages/ai/src/types.ts:1216](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1216)
9​
10Emitted when a tool call completes.
11​
12@ag-ui/core provides: `toolCallId`
13TanStack AI adds: `model?`, `toolCallName?`, `toolName?` (deprecated), `input?`, `result?`
14​
15## Extends
16​
17- `ToolCallEndEvent`
18​
19## Indexable
20​
21```ts
22[k: string]: unknown
23```
24​
25## Properties
26​
27### input?
28​
29```ts
30optional input: unknown;
31```
32​
33Defined in: [packages/ai/src/types.ts:1227](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1227)
34​
35Final parsed input arguments (TanStack AI internal)
36​
37***
38​
39### model?
40​
41```ts
42optional model: string;
43```
44​
45Defined in: [packages/ai/src/types.ts:1218](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1218)
46​
47Model identifier for multi-model support
48​
49***
50​
51### result?
52​
53```ts
54optional result:
55 | string
56 | ContentPart<unknown, unknown, unknown, unknown, unknown>[];
57```
58​
59Defined in: [packages/ai/src/types.ts:1229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1229)
60​
61Tool execution result (TanStack AI internal)
62​
63***
64​
65### state?
66​
67```ts
68optional state: ToolOutputState;
69```
70​
71Defined in: [packages/ai/src/types.ts:1231](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1231)
72​
73Tool execution output state (TanStack AI internal)
74​
75***
76​
77### toolCallName?
78​
79```ts
80optional toolCallName: string;
81```
82​
83Defined in: [packages/ai/src/types.ts:1220](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1220)
84​
85Name of the tool that completed
86​
87***
88​
89### ~~toolName?~~
90​
91```ts
92optional toolName: string;
93```
94​
95Defined in: [packages/ai/src/types.ts:1225](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1225)
96​
97#### Deprecated
98​
99Use `toolCallName` instead.
100Kept for backward compatibility.