TanStackRunMetadata

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

Shape of metadata.tanstack on run events.

Properties#

args?#

optional args?: string;

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

The raw tool argument string on TOOL_CALL_END, as the provider sent it.

finishReason?#

optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null;

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

index?#

optional index?: number;

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

input?#

optional input?: unknown;

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

Parsed TOOL_CALL_END input. Spec TOOL_CALL_END has no top-level input.

interruptErrors?#

optional interruptErrors?: readonly InterruptSubmissionError[];

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

model?#

optional model?: string;

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

responseId?#

optional responseId?: string;

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

responseItems?#

optional responseItems?: object[];

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

The answer items of this model call. See TanStackMessageMetadata.responseItems.

id#

id: string;

phase?#

optional phase?: string;

retryAfterMs?#

optional retryAfterMs?: number;

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

On a RUN_ERROR. See RunErrorEvent.retryAfterMs.

runId?#

optional runId?: string;

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

sessionId?#

optional sessionId?: string;

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

source?#

optional source?: MessageSource;

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

state?#

optional state?: ToolOutputState;

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

threadId?#

optional threadId?: string;

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

usage?#

optional usage?: TokenUsageLeftover;

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

TokenUsage fields that have no AG-UI usage[] equivalent.