Interface: ToolCallPart<TMetadata>#

Defined in: packages/typescript/ai/src/types.ts:335

Type Parameters#

TMetadata#

TMetadata = unknown

Properties#

approval?#

optional approval: object;

optional approval: object;

Defined in: packages/typescript/ai/src/types.ts:342

Approval metadata if tool requires user approval

approved?#

optional approved: boolean;

optional approved: boolean;

id#

id: string;

id: string;

needsApproval#

needsApproval: boolean;

needsApproval: boolean;

arguments#

arguments: string;

arguments: string;

Defined in: packages/typescript/ai/src/types.ts:339

id#

id: string;

id: string;

Defined in: packages/typescript/ai/src/types.ts:337

metadata?#

optional metadata: TMetadata;

optional metadata: TMetadata;

Defined in: packages/typescript/ai/src/types.ts:351

Provider-specific metadata that round-trips with the tool call. Typed per-adapter via TToolCallMetadata.

name#

name: string;

name: string;

Defined in: packages/typescript/ai/src/types.ts:338

output?#

optional output: any;

optional output: any;

Defined in: packages/typescript/ai/src/types.ts:348

Tool execution output (for client tools or after approval)

state#

state: ToolCallState;

state: ToolCallState;

Defined in: packages/typescript/ai/src/types.ts:340

type#

type: "tool-call";

type: "tool-call";

Defined in: packages/typescript/ai/src/types.ts:336