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

ToolCallEndEvent.md

86 lines1.7 KB

1---
2id: ToolCallEndEvent
3title: ToolCallEndEvent
4---
5​
6# Interface: ToolCallEndEvent
7​
8Defined in: [packages/typescript/ai/src/types.ts:1028](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1028)
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/typescript/ai/src/types.ts:1039](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1039)
34​
35Final parsed input arguments (TanStack AI internal)
36​
37***
38​
39### model?
40​
41```ts
42optional model: string;
43```
44​
45Defined in: [packages/typescript/ai/src/types.ts:1030](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1030)
46​
47Model identifier for multi-model support
48​
49***
50​
51### result?
52​
53```ts
54optional result: string;
55```
56​
57Defined in: [packages/typescript/ai/src/types.ts:1041](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1041)
58​
59Tool execution result (TanStack AI internal)
60​
61***
62​
63### toolCallName?
64​
65```ts
66optional toolCallName: string;
67```
68​
69Defined in: [packages/typescript/ai/src/types.ts:1032](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1032)
70​
71Name of the tool that completed
72​
73***
74​
75### ~~toolName?~~
76​
77```ts
78optional toolName: string;
79```
80​
81Defined in: [packages/typescript/ai/src/types.ts:1037](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1037)
82​
83#### Deprecated
84​
85Use `toolCallName` instead.
86Kept for backward compatibility.