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

StepStartedEvent.md

62 lines1.1 KB

1---
2id: StepStartedEvent
3title: StepStartedEvent
4---
5​
6# Interface: StepStartedEvent
7​
8Defined in: [packages/ai/src/types.ts:1253](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1253)
9​
10Emitted when a thinking/reasoning step starts.
11​
12@ag-ui/core provides: `stepName`
13TanStack AI adds: `model?`, `stepId?` (deprecated alias), `stepType?`
14​
15## Extends
16​
17- `StepStartedEvent`
18​
19## Indexable
20​
21```ts
22[k: string]: unknown
23```
24​
25## Properties
26​
27### model?
28​
29```ts
30optional model: string;
31```
32​
33Defined in: [packages/ai/src/types.ts:1255](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1255)
34​
35Model identifier for multi-model support
36​
37***
38​
39### ~~stepId?~~
40​
41```ts
42optional stepId: string;
43```
44​
45Defined in: [packages/ai/src/types.ts:1260](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1260)
46​
47#### Deprecated
48​
49Use `stepName` instead (from @ag-ui/core spec).
50Kept for backward compatibility.
51​
52***
53​
54### stepType?
55​
56```ts
57optional stepType: string;
58```
59​
60Defined in: [packages/ai/src/types.ts:1262](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1262)
61​
62Type of step (e.g., 'thinking', 'planning')