2.6 KiB
| id | title |
|---|---|
| ToolCallPart | ToolCallPart |
Interface: ToolCallPart<TMetadata>
Defined in: packages/ai/src/types.ts:410
Type Parameters
TMetadata
TMetadata = unknown
Properties
approval?
optional approval?: object;
Defined in: packages/ai/src/types.ts:426
Approval metadata if tool requires user approval
approved?
optional approved?: boolean;
id
id: string;
needsApproval
needsApproval: boolean;
arguments
arguments: string;
Defined in: packages/ai/src/types.ts:414
id
id: string;
Defined in: packages/ai/src/types.ts:412
input?
optional input?: unknown;
Defined in: packages/ai/src/types.ts:423
Parsed tool input. Set from the parsed arguments once they are complete
(state: 'input-complete' and later). undefined while the raw
arguments string is still streaming, and may stay undefined for a call
that terminates in an error state — the raw arguments string is always
available as a fallback. Typed per-tool on the client ToolCallPart (see
@tanstack/ai-client); unknown on this base type.
metadata?
optional metadata?: TMetadata;
Defined in: packages/ai/src/types.ts:437
Provider-specific metadata that round-trips with the tool call.
Typed per-adapter via TToolCallMetadata. May follow the
ProviderExecutedToolMetadata convention to mark provider-executed
server tools (e.g. Anthropic web_search).
name
name: string;
Defined in: packages/ai/src/types.ts:413
output?
optional output?: any;
Defined in: packages/ai/src/types.ts:432
Tool execution output (for client tools or after approval)
state
state: ToolCallState;
Defined in: packages/ai/src/types.ts:424
type
type: "tool-call";
Defined in: packages/ai/src/types.ts:411