0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/TanStackRunMetadata.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

2.2 KiB

id title
TanStackRunMetadata TanStackRunMetadata

Interface: TanStackRunMetadata

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

Shape of metadata.tanstack on run events.

Properties

finishReason?

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

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


index?

optional index?: number;

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


input?

optional input?: unknown;

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

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:559


model?

optional model?: string;

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


runId?

optional runId?: string;

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


sessionId?

optional sessionId?: string;

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


state?

optional state?: ToolOutputState;

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


threadId?

optional threadId?: string;

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


usage?

optional usage?: TokenUsageLeftover;

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

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