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

StepFinishedEvent.md

86 lines1.7 KB

1---
2id: StepFinishedEvent
3title: StepFinishedEvent
4---
5​
6# Interface: StepFinishedEvent
7​
8Defined in: [packages/typescript/ai/src/types.ts:1079](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1079)
9​
10Emitted when a thinking/reasoning step finishes.
11​
12@ag-ui/core provides: `stepName`
13TanStack AI adds: `model?`, `stepId?` (deprecated alias), `delta?`, `content?`
14​
15## Extends
16​
17- `StepFinishedEvent`
18​
19## Indexable
20​
21```ts
22[k: string]: unknown
23```
24​
25## Properties
26​
27### content?
28​
29```ts
30optional content: string;
31```
32​
33Defined in: [packages/typescript/ai/src/types.ts:1090](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1090)
34​
35Full accumulated thinking content (TanStack AI internal)
36​
37***
38​
39### delta?
40​
41```ts
42optional delta: string;
43```
44​
45Defined in: [packages/typescript/ai/src/types.ts:1088](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1088)
46​
47Incremental thinking content (TanStack AI internal)
48​
49***
50​
51### model?
52​
53```ts
54optional model: string;
55```
56​
57Defined in: [packages/typescript/ai/src/types.ts:1081](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1081)
58​
59Model identifier for multi-model support
60​
61***
62​
63### signature?
64​
65```ts
66optional signature: string;
67```
68​
69Defined in: [packages/typescript/ai/src/types.ts:1092](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1092)
70​
71Provider signature for the thinking block
72​
73***
74​
75### ~~stepId?~~
76​
77```ts
78optional stepId: string;
79```
80​
81Defined in: [packages/typescript/ai/src/types.ts:1086](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1086)
82​
83#### Deprecated
84​
85Use `stepName` instead (from @ag-ui/core spec).
86Kept for backward compatibility.