0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/interfaces/ToolCall.md
github-actions[bot] f4f32bdcc2
docs: regenerate API documentation (#1195)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-22 08:16:20 +00:00

1.2 KiB

id title
ToolCall ToolCall

Interface: ToolCall<TMetadata>

Defined in: packages/ai/src/types.ts:166

Type Parameters

TMetadata

TMetadata = unknown

Properties

function

function: object;

Defined in: packages/ai/src/types.ts:169

arguments

arguments: string;

name

name: string;

id

id: string;

Defined in: packages/ai/src/types.ts:167


metadata?

optional metadata?: TMetadata;

Defined in: packages/ai/src/types.ts:176

Provider-specific metadata to carry through the tool call lifecycle. Typed per-adapter via TToolCallMetadata. For example, @tanstack/ai-gemini sets this to { thoughtSignature?: string }.


type

type: "function";

Defined in: packages/ai/src/types.ts:168