Skip to content

Commit 6176067

Browse files
github-actions[bot]github-actions[bot]
authored
docs: regenerate API documentation (#631)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 27d2c54 commit 6176067

101 files changed

Lines changed: 418 additions & 417 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/reference/classes/StreamProcessor.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Useful for auto-continue logic
177177
clearMessages(): void;
178178
```
179179
180-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:419](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L419)
180+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:420](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L420)
181181
182182
Clear all messages
183183
@@ -193,7 +193,7 @@ Clear all messages
193193
finalizeStream(): void;
194194
```
195195
196-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1683](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1683)
196+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1684](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1684)
197197
198198
Finalize the stream — complete all pending operations.
199199
@@ -251,7 +251,7 @@ Get current messages
251251
getRecording(): ChunkRecording | null;
252252
```
253253
254-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1844](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1844)
254+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1845](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1845)
255255
256256
Get the current recording
257257
@@ -267,7 +267,7 @@ Get the current recording
267267
getState(): ProcessorState;
268268
```
269269
270-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1801](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1801)
270+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1802](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1802)
271271
272272
Get current processor state (aggregated across all messages)
273273
@@ -303,7 +303,7 @@ auto-continuation produces no content.
303303
process(stream): Promise<ProcessorResult>;
304304
```
305305
306-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:436](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L436)
306+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:437](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L437)
307307
308308
Process a stream and emit events through handlers
309309
@@ -325,7 +325,7 @@ Process a stream and emit events through handlers
325325
processChunk(chunk): void;
326326
```
327327
328-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:470](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L470)
328+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:471](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L471)
329329
330330
Process a single chunk from the stream.
331331
@@ -355,7 +355,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering
355355
removeMessagesAfter(index): void;
356356
```
357357
358-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:390](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L390)
358+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:391](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L391)
359359
360360
Remove messages after a certain index (for reload/retry)
361361
@@ -377,7 +377,7 @@ Remove messages after a certain index (for reload/retry)
377377
reset(): void;
378378
```
379379
380-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1868](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1868)
380+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1869](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1869)
381381
382382
Full reset (including messages)
383383
@@ -440,7 +440,7 @@ an assistant message which can cause empty message flicker.
440440
startRecording(): void;
441441
```
442442
443-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1831](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1831)
443+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1832](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1832)
444444
445445
Start recording chunks
446446
@@ -478,7 +478,7 @@ Get the conversation as ModelMessages (for sending to LLM)
478478
static replay(recording, options?): Promise<ProcessorResult>;
479479
```
480480
481-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1887](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1887)
481+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1888](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1888)
482482
483483
Replay a recording through the processor
484484

‎docs/reference/functions/convertMessagesToModelMessages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function convertMessagesToModelMessages(messages): ModelMessage<
1212
| null>[];
1313
```
1414

15-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L71)
15+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:79](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L79)
1616

1717
Convert UIMessages or ModelMessages to ModelMessages
1818

‎docs/reference/functions/createReplayStream.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createReplayStream
99
function createReplayStream(recording): AsyncIterable<AGUIEvent>;
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1899](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1899)
12+
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1900](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1900)
1313

1414
Create an async iterable from a recording
1515

‎docs/reference/functions/generateMessageId.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: generateMessageId
99
function generateMessageId(): string;
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:529](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L529)
12+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:549](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L549)
1313

1414
Generate a unique message ID
1515

‎docs/reference/functions/modelMessageToUIMessage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: modelMessageToUIMessage
99
function modelMessageToUIMessage(modelMessage, id?): UIMessage;
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:385](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L385)
12+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:394](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L394)
1313

1414
Convert a ModelMessage to UIMessage
1515

‎docs/reference/functions/modelMessagesToUIMessages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: modelMessagesToUIMessages
99
function modelMessagesToUIMessages(modelMessages): UIMessage<unknown>[];
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:456](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L456)
12+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:465](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L465)
1313

1414
Convert an array of ModelMessages to UIMessages
1515

‎docs/reference/functions/normalizeToUIMessage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: normalizeToUIMessage
99
function normalizeToUIMessage(message, generateId): UIMessage;
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:506](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L506)
12+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:526](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L526)
1313

1414
Normalize a message (UIMessage or ModelMessage) to a UIMessage
1515
Ensures the message has an ID and createdAt timestamp

‎docs/reference/functions/uiMessageToModelMessages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function uiMessageToModelMessages(uiMessage): ModelMessage<
1212
| null>[];
1313
```
1414

15-
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:146](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L146)
15+
Defined in: [packages/typescript/ai/src/activities/chat/messages.ts:154](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L154)
1616

1717
Convert a UIMessage to ModelMessage(s)
1818

‎docs/reference/interfaces/AgentLoopState.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AgentLoopState
55

66
# Interface: AgentLoopState
77

8-
Defined in: [packages/typescript/ai/src/types.ts:702](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L702)
8+
Defined in: [packages/typescript/ai/src/types.ts:703](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L703)
99

1010
State passed to agent loop strategy for determining whether to continue
1111

@@ -17,7 +17,7 @@ State passed to agent loop strategy for determining whether to continue
1717
finishReason: string | null;
1818
```
1919

20-
Defined in: [packages/typescript/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L708)
20+
Defined in: [packages/typescript/ai/src/types.ts:709](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L709)
2121

2222
Finish reason from the last response
2323

@@ -29,7 +29,7 @@ Finish reason from the last response
2929
iterationCount: number;
3030
```
3131

32-
Defined in: [packages/typescript/ai/src/types.ts:704](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L704)
32+
Defined in: [packages/typescript/ai/src/types.ts:705](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L705)
3333

3434
Current iteration count (0-indexed)
3535

@@ -44,6 +44,6 @@ messages: ModelMessage<
4444
| null>[];
4545
```
4646

47-
Defined in: [packages/typescript/ai/src/types.ts:706](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L706)
47+
Defined in: [packages/typescript/ai/src/types.ts:707](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L707)
4848

4949
Current messages array

‎docs/reference/interfaces/ApprovalRequestedEvent.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: ApprovalRequestedEvent
55

66
# Interface: ApprovalRequestedEvent
77

8-
Defined in: [packages/typescript/ai/src/types.ts:1195](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1195)
8+
Defined in: [packages/typescript/ai/src/types.ts:1196](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1196)
99

1010
Emitted when a server tool requires approval before execution. The agent
1111
loop yields this and pauses — `structured-output.complete` will not fire
@@ -31,7 +31,7 @@ for that run. The shape is fixed by the orchestrator's tool-approval flow
3131
optional model: string;
3232
```
3333

34-
Defined in: [packages/typescript/ai/src/types.ts:1147](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1147)
34+
Defined in: [packages/typescript/ai/src/types.ts:1148](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1148)
3535

3636
Model identifier for multi-model support
3737

@@ -47,7 +47,7 @@ Model identifier for multi-model support
4747
name: "approval-requested";
4848
```
4949

50-
Defined in: [packages/typescript/ai/src/types.ts:1196](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1196)
50+
Defined in: [packages/typescript/ai/src/types.ts:1197](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1197)
5151

5252
#### Overrides
5353

@@ -63,7 +63,7 @@ CustomEvent.name
6363
value: object;
6464
```
6565

66-
Defined in: [packages/typescript/ai/src/types.ts:1197](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1197)
66+
Defined in: [packages/typescript/ai/src/types.ts:1198](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1198)
6767

6868
#### approval
6969

0 commit comments

Comments
 (0)