0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/interfaces/InternalToolCallState.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

2 KiB

id title
InternalToolCallState InternalToolCallState

Interface: InternalToolCallState

Defined in: packages/ai/src/activities/chat/stream/types.ts:21

Internal state for a tool call being tracked

Properties

arguments

arguments: string;

Defined in: packages/ai/src/activities/chat/stream/types.ts:24


id

id: string;

Defined in: packages/ai/src/activities/chat/stream/types.ts:22


index

index: number;

Defined in: packages/ai/src/activities/chat/stream/types.ts:27


metadata?

optional metadata?: Record<string, unknown>;

Defined in: packages/ai/src/activities/chat/stream/types.ts:32

Provider-specific metadata that round-trips with the tool call (e.g. Gemini's thoughtSignature). Untyped at this layer because the stream processor is provider-agnostic; adapters narrow it via their TToolCallMetadata generic.


name

name: string;

Defined in: packages/ai/src/activities/chat/stream/types.ts:23


parsedArguments?

optional parsedArguments?: any;

Defined in: packages/ai/src/activities/chat/stream/types.ts:26


state

state: ToolCallState;

Defined in: packages/ai/src/activities/chat/stream/types.ts:25