Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

RunFinishedEvent.md

59 lines1.2 KB

1---
2id: RunFinishedEvent
3title: RunFinishedEvent
4---
5​
6# Interface: RunFinishedEvent
7​
8Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109)
9​
10Emitted when a run completes successfully.
11​
12@ag-ui/core provides: `threadId`, `runId`, `result?`
13TanStack AI adds: `model?`, `finishReason?`, `usage?`
14​
15## Extends
16​
17- `RunFinishedEvent`
18​
19## Indexable
20​
21```ts
22[k: string]: unknown
23```
24​
25## Properties
26​
27### finishReason?
28​
29```ts
30optional finishReason: "length" | "stop" | "content_filter" | "tool_calls" | null;
31```
32​
33Defined in: [packages/ai/src/types.ts:1113](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1113)
34​
35Why the generation stopped
36​
37***
38​
39### model?
40​
41```ts
42optional model: string;
43```
44​
45Defined in: [packages/ai/src/types.ts:1111](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1111)
46​
47Model identifier for multi-model support
48​
49***
50​
51### usage?
52​
53```ts
54optional usage: TokenUsage<ProviderUsageDetails>;
55```
56​
57Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115)
58​
59Token usage statistics with optional detailed breakdowns and provider-reported cost.