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

ToolCallPart.md

119 lines2.1 KB

Interface: ToolCallPart<TMetadata>

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

Type Parameters

TMetadata

TMetadata = unknown

Properties

approval?

optional approval: object;

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

Approval metadata if tool requires user approval

approved?

optional approved: boolean;

id

id: string;

needsApproval

needsApproval: boolean;

arguments

arguments: string;

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


id

id: string;

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


metadata?

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;

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


output?

optional output: any;

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

Tool execution output (for client tools or after approval)


state

state: ToolCallState;

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


type

type: "tool-call";

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