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

ToolDefinitionConfig.md

98 lines2.4 KB

1---
2id: ToolDefinitionConfig
3title: ToolDefinitionConfig
4---
5​
6# Interface: ToolDefinitionConfig\<TInput, TOutput, TName, TNeedsApproval\>
7​
8Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L107)
9​
10Tool definition configuration
11​
12## Type Parameters
13​
14### TInput
15​
16`TInput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = [`SchemaInput`](../type-aliases/SchemaInput.md)
17​
18### TOutput
19​
20`TOutput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = [`SchemaInput`](../type-aliases/SchemaInput.md)
21​
22### TName
23​
24`TName` *extends* `string` = `string`
25​
26### TNeedsApproval
27​
28`TNeedsApproval` *extends* `boolean` = `false`
29​
30## Properties
31​
32### description
33​
34```ts
35description: string;
36```
37​
38Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L114)
39​
40***
41​
42### inputSchema?
43​
44```ts
45optional inputSchema: TInput;
46```
47​
48Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:115](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L115)
49​
50***
51​
52### lazy?
53​
54```ts
55optional lazy: boolean;
56```
57​
58Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L118)
59​
60***
61​
62### metadata?
63​
64```ts
65optional metadata: Record<string, unknown>;
66```
67​
68Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L119)
69​
70***
71​
72### name
73​
74```ts
75name: TName;
76```
77​
78Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L113)
79​
80***
81​
82### needsApproval?
83​
84```ts
85optional needsApproval: TNeedsApproval;
86```
87​
88Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L117)
89​
90***
91​
92### outputSchema?
93​
94```ts
95optional outputSchema: TOutput;
96```
97​
98Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:116](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L116)