mirror of
https://github.com/TanStack/ai.git
synced 2026-11-18 19:34:58 +00:00
1.4 KiB
1.4 KiB
| id | title |
|---|---|
| ToolCallStartEvent | ToolCallStartEvent |
Interface: ToolCallStartEvent
Defined in: packages/ai/src/types.ts:1272
Emitted when a tool call starts.
@ag-ui/core provides: toolCallId, toolCallName, parentMessageId?
Field shapes are taken from AG-UI via Pick (not extends) so Zod
.passthrough() index signatures do not pollute the StreamChunk
discriminated union — required for KnownCustomEvent narrowing.
Extends
Pick<AGUIToolCallStartEvent, |"toolCallId"|"toolCallName"|"parentMessageId"|"timestamp"|"rawEvent">
Properties
metadata?
optional metadata?: Record<string, any>;
Defined in: packages/ai/src/types.ts:1280
Provider-specific metadata to carry into the ToolCall.
toolName?
optional toolName?: string;
Defined in: packages/ai/src/types.ts:1278
Alias of toolCallName. Kept so existing stream readers still compile.
type
type: "TOOL_CALL_START";
Defined in: packages/ai/src/types.ts:1276