Skip to content

Commit c2172c9

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

110 files changed

Lines changed: 462 additions & 429 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/ConsoleLogger.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,23 @@ title: ConsoleLogger
55

66
# Class: ConsoleLogger
77

8-
Defined in: [packages/ai/src/logger/console-logger.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L25)
8+
Defined in: [packages/ai/src/logger/console-logger.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L101)
99

10-
Pluggable logger interface consumed by every `@tanstack/ai` activity when `debug` is enabled. Supply a custom implementation via `debug: { logger }` on `chat()`, `summarize()`, `generateImage()`, etc. The four methods correspond to log levels: use `debug` for chunk-level diagnostic output, `info`/`warn` for notable events, `error` for caught exceptions.
10+
Default `Logger` implementation that routes each level to the matching
11+
`console` method:
12+
13+
- `debug``console.debug`
14+
- `info``console.info`
15+
- `warn``console.warn`
16+
- `error``console.error`
17+
18+
When a `meta` object is supplied it is rendered with the strategy that
19+
actually surfaces it on the current runtime (see MetaStrategy):
20+
depth-unlimited `console.dir` on Node, circular-safe JSON on Cloudflare
21+
Workers, and an extra console argument everywhere else.
22+
23+
This is the logger used when `debug` is enabled on any activity and no
24+
custom `logger` is supplied via `debug: { logger }`.
1125

1226
## Implements
1327

@@ -33,7 +47,7 @@ new ConsoleLogger(): ConsoleLogger;
3347
debug(message, meta?): void;
3448
```
3549
36-
Defined in: [packages/ai/src/logger/console-logger.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L27)
50+
Defined in: [packages/ai/src/logger/console-logger.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L103)
3751
3852
Log a debug-level message; forwards to `console.debug`.
3953
@@ -63,7 +77,7 @@ Log a debug-level message; forwards to `console.debug`.
6377
error(message, meta?): void;
6478
```
6579
66-
Defined in: [packages/ai/src/logger/console-logger.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L45)
80+
Defined in: [packages/ai/src/logger/console-logger.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L118)
6781
6882
Log an error-level message; forwards to `console.error`.
6983
@@ -93,7 +107,7 @@ Log an error-level message; forwards to `console.error`.
93107
info(message, meta?): void;
94108
```
95109
96-
Defined in: [packages/ai/src/logger/console-logger.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L33)
110+
Defined in: [packages/ai/src/logger/console-logger.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L108)
97111
98112
Log an info-level message; forwards to `console.info`.
99113
@@ -123,7 +137,7 @@ Log an info-level message; forwards to `console.info`.
123137
warn(message, meta?): void;
124138
```
125139
126-
Defined in: [packages/ai/src/logger/console-logger.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L39)
140+
Defined in: [packages/ai/src/logger/console-logger.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L113)
127141
128142
Log a warning-level message; forwards to `console.warn`.
129143

docs/reference/classes/StreamProcessor.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Clear all messages
193193
finalizeStream(): void;
194194
```
195195
196-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1812](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1812)
196+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1839](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1839)
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/ai/src/activities/chat/stream/processor.ts:1976](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1976)
254+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2003](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2003)
255255
256256
Get the current recording
257257
@@ -267,7 +267,7 @@ Get the current recording
267267
getState(): ProcessorState;
268268
```
269269
270-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1933](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1933)
270+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1960](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1960)
271271
272272
Get current processor state (aggregated across all messages)
273273
@@ -377,7 +377,7 @@ Remove messages after a certain index (for reload/retry)
377377
reset(): void;
378378
```
379379
380-
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2001](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2001)
380+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2028](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2028)
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/ai/src/activities/chat/stream/processor.ts:1963](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1963)
443+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:1990](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L1990)
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/ai/src/activities/chat/stream/processor.ts:2020](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2020)
481+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2047](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2047)
482482
483483
Replay a recording through the processor
484484

docs/reference/functions/chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: chat
99
function chat<TAdapter, TSchema, TStream, TTools, TMiddleware>(options): TextActivityResult<TSchema, TStream>;
1010
```
1111

12-
Defined in: [packages/ai/src/activities/chat/index.ts:2536](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2536)
12+
Defined in: [packages/ai/src/activities/chat/index.ts:2537](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2537)
1313

1414
Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.
1515

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/ai/src/activities/chat/stream/processor.ts:2032](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2032)
12+
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2059](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2059)
1313

1414
Create an async iterable from a recording
1515

docs/reference/functions/createVideoOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createVideoOptions
99
function createVideoOptions<TAdapter, TStream>(options): VideoCreateOptions<TAdapter, TStream>;
1010
```
1111

12-
Defined in: [packages/ai/src/activities/generateVideo/index.ts:547](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L547)
12+
Defined in: [packages/ai/src/activities/generateVideo/index.ts:559](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L559)
1313

1414
Create typed options for the generateVideo() function without executing.
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/ai/src/activities/chat/messages.ts:550](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L550)
12+
Defined in: [packages/ai/src/activities/chat/messages.ts:551](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L551)
1313

1414
Generate a unique message ID
1515

docs/reference/functions/generateVideo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: generateVideo
99
function generateVideo<TAdapter, TStream>(options): TStream extends true ? AsyncIterable<AGUIEvent, any, any> : Promise<VideoJobResult>;
1010
```
1111

12-
Defined in: [packages/ai/src/activities/generateVideo/index.ts:231](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L231)
12+
Defined in: [packages/ai/src/activities/generateVideo/index.ts:232](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L232)
1313

1414
**`Experimental`**
1515

docs/reference/functions/getVideoJobStatus.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ function getVideoJobStatus<TAdapter>(options): Promise<{
1111
progress?: number;
1212
status: "pending" | "processing" | "completed" | "failed";
1313
url?: string;
14+
usage?: TokenUsage<ProviderUsageDetails>;
1415
}>;
1516
```
1617

17-
Defined in: [packages/ai/src/activities/generateVideo/index.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L447)
18+
Defined in: [packages/ai/src/activities/generateVideo/index.ts:449](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L449)
1819

1920
**`Experimental`**
2021

@@ -50,6 +51,7 @@ it will automatically fetch and include the video URL.
5051
`progress?`: `number`;
5152
`status`: `"pending"` \| `"processing"` \| `"completed"` \| `"failed"`;
5253
`url?`: `string`;
54+
`usage?`: `TokenUsage`\<`ProviderUsageDetails`\>;
5355
\}\>
5456

5557
## Example

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/ai/src/activities/chat/messages.ts:395](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L395)
12+
Defined in: [packages/ai/src/activities/chat/messages.ts:396](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L396)
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/ai/src/activities/chat/messages.ts:466](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L466)
12+
Defined in: [packages/ai/src/activities/chat/messages.ts:467](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L467)
1313

1414
Convert an array of ModelMessages to UIMessages
1515

0 commit comments

Comments
 (0)