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

ToolCall.md

70 lines1.3 KB

1---
2id: ToolCall
3title: ToolCall
4---
5​
6# Interface: ToolCall\<TMetadata\>
7​
8Defined in: [packages/typescript/ai/src/types.ts:135](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L135)
9​
10## Type Parameters
11​
12### TMetadata
13​
14`TMetadata` = `unknown`
15​
16## Properties
17​
18### function
19​
20```ts
21function: object;
22```
23​
24Defined in: [packages/typescript/ai/src/types.ts:138](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L138)
25​
26#### arguments
27​
28```ts
29arguments: string;
30```
31​
32#### name
33​
34```ts
35name: string;
36```
37​
38***
39​
40### id
41​
42```ts
43id: string;
44```
45​
46Defined in: [packages/typescript/ai/src/types.ts:136](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L136)
47​
48***
49​
50### metadata?
51​
52```ts
53optional metadata: TMetadata;
54```
55​
56Defined in: [packages/typescript/ai/src/types.ts:145](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L145)
57​
58Provider-specific metadata to carry through the tool call lifecycle.
59Typed per-adapter via `TToolCallMetadata`. For example,
60`@tanstack/ai-gemini` sets this to `{ thoughtSignature?: string }`.
61​
62***
63​
64### type
65​
66```ts
67type: "function";
68```
69​
70Defined in: [packages/typescript/ai/src/types.ts:137](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L137)