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

RealtimeToolConfig.md

51 lines1.1 KB

1---
2id: RealtimeToolConfig
3title: RealtimeToolConfig
4---
5​
6# Interface: RealtimeToolConfig
7​
8Defined in: [packages/ai/src/realtime/types.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L25)
9​
10Serializable tool descriptor for realtime session configuration.
11Contains only the metadata needed by providers, not Zod schemas or execute functions.
12​
13## Properties
14​
15### description
16​
17```ts
18description: string;
19```
20​
21Defined in: [packages/ai/src/realtime/types.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L27)
22​
23***
24​
25### inputSchema?
26​
27```ts
28optional inputSchema: Record<string, any>;
29```
30​
31Defined in: [packages/ai/src/realtime/types.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L28)
32​
33***
34​
35### name
36​
37```ts
38name: string;
39```
40​
41Defined in: [packages/ai/src/realtime/types.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L26)
42​
43***
44​
45### outputSchema?
46​
47```ts
48optional outputSchema: Record<string, any>;
49```
50​
51Defined in: [packages/ai/src/realtime/types.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L29)