RunFinishedEvent

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

Emitted when a run completes successfully.

@ag-ui/core provides: threadId, runId, result?, outcome? Spec usage[] is provider/model token counts. TanStack leftovers live in metadata.tanstack.

Extends#

• Pick<AGUIRunFinishedEvent, "threadId" | "runId" | "result" | "outcome" | "timestamp" | "rawEvent">

Properties#

finishReason?#

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

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

Restored on the client from metadata.tanstack.

metadata?#

optional metadata?: object & Record<string, any>;

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

Type Declaration#

tanstack?#

optional tanstack?: TanStackRunMetadata;

model?#

optional model?: string;

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

Restored on the client from metadata.tanstack.

responseId?#

optional responseId?: string;

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

Provider generation ID. Restored from metadata.tanstack.

type#

type: RUN_FINISHED;

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

usage?#

optional usage?: TokenUsage<ProviderUsageDetails> | TokenUsage[];

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