Docs
CodeRabbit
Cloudflare
Railway
SerpAPI
AG Grid
Clerk
WorkOS
OpenRouter
Netlify
Unkey
Sentry
Prisma
Electric
CodeRabbit
Cloudflare
Railway
SerpAPI
AG Grid
Clerk
WorkOS
OpenRouter
Netlify
Unkey
Sentry
Prisma
Electric
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

ToolCall

Interface: ToolCall<TMetadata>

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

Type Parameters

TMetadata

TMetadata = unknown

Properties

function

ts
function: object;
function: object;

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

arguments

ts
arguments: string;
arguments: string;

name

ts
name: string;
name: string;

id

ts
id: string;
id: string;

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


metadata?

ts
optional metadata: TMetadata;
optional metadata: TMetadata;

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

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

ts
type: "function";
type: "function";

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