Skip to content

Commit e33ee09

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

104 files changed

Lines changed: 1006 additions & 372 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.
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
id: ConsoleLogger
3+
title: ConsoleLogger
4+
---
5+
6+
# Class: ConsoleLogger
7+
8+
Defined in: [packages/typescript/ai/src/logger/console-logger.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L25)
9+
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.
11+
12+
## Implements
13+
14+
- [`Logger`](../interfaces/Logger.md)
15+
16+
## Constructors
17+
18+
### Constructor
19+
20+
```ts
21+
new ConsoleLogger(): ConsoleLogger;
22+
```
23+
24+
#### Returns
25+
26+
`ConsoleLogger`
27+
28+
## Methods
29+
30+
### debug()
31+
32+
```ts
33+
debug(message, meta?): void;
34+
```
35+
36+
Defined in: [packages/typescript/ai/src/logger/console-logger.ts:27](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L27)
37+
38+
Log a debug-level message; forwards to `console.debug`.
39+
40+
#### Parameters
41+
42+
##### message
43+
44+
`string`
45+
46+
##### meta?
47+
48+
`Record`\<`string`, `unknown`\>
49+
50+
#### Returns
51+
52+
`void`
53+
54+
#### Implementation of
55+
56+
[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug)
57+
58+
***
59+
60+
### error()
61+
62+
```ts
63+
error(message, meta?): void;
64+
```
65+
66+
Defined in: [packages/typescript/ai/src/logger/console-logger.ts:45](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L45)
67+
68+
Log an error-level message; forwards to `console.error`.
69+
70+
#### Parameters
71+
72+
##### message
73+
74+
`string`
75+
76+
##### meta?
77+
78+
`Record`\<`string`, `unknown`\>
79+
80+
#### Returns
81+
82+
`void`
83+
84+
#### Implementation of
85+
86+
[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error)
87+
88+
***
89+
90+
### info()
91+
92+
```ts
93+
info(message, meta?): void;
94+
```
95+
96+
Defined in: [packages/typescript/ai/src/logger/console-logger.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L33)
97+
98+
Log an info-level message; forwards to `console.info`.
99+
100+
#### Parameters
101+
102+
##### message
103+
104+
`string`
105+
106+
##### meta?
107+
108+
`Record`\<`string`, `unknown`\>
109+
110+
#### Returns
111+
112+
`void`
113+
114+
#### Implementation of
115+
116+
[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info)
117+
118+
***
119+
120+
### warn()
121+
122+
```ts
123+
warn(message, meta?): void;
124+
```
125+
126+
Defined in: [packages/typescript/ai/src/logger/console-logger.ts:39](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L39)
127+
128+
Log a warning-level message; forwards to `console.warn`.
129+
130+
#### Parameters
131+
132+
##### message
133+
134+
`string`
135+
136+
##### meta?
137+
138+
`Record`\<`string`, `unknown`\>
139+
140+
#### Returns
141+
142+
`void`
143+
144+
#### Implementation of
145+
146+
[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn)

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>(options): TextActivityResult<TSchema, TStream>;
1010
```
1111

12-
Defined in: [packages/typescript/ai/src/activities/chat/index.ts:1451](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L1451)
12+
Defined in: [packages/typescript/ai/src/activities/chat/index.ts:1512](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L1512)
1313

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

docs/reference/functions/createChatOptions.md

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

12-
Defined in: [packages/typescript/ai/src/activities/chat/index.ts:203](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L203)
12+
Defined in: [packages/typescript/ai/src/activities/chat/index.ts:213](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L213)
1313

1414
Create typed options for the chat() function without executing.
1515
This is useful for pre-defining configurations with full type inference.

docs/reference/functions/createImageOptions.md

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

12-
Defined in: [packages/typescript/ai/src/activities/generateImage/index.ts:244](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L244)
12+
Defined in: [packages/typescript/ai/src/activities/generateImage/index.ts:270](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L270)
1313

1414
Create typed options for the generateImage() function without executing.
1515

docs/reference/functions/createSpeechOptions.md

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

12-
Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:181](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L181)
12+
Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:213](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L213)
1313

1414
Create typed options for the generateSpeech() function without executing.
1515

docs/reference/functions/createSummarizeOptions.md

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

12-
Defined in: [packages/typescript/ai/src/activities/summarize/index.ts:254](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/index.ts#L254)
12+
Defined in: [packages/typescript/ai/src/activities/summarize/index.ts:300](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/index.ts#L300)
1313

1414
Create typed options for the summarize() function without executing.
1515

docs/reference/functions/createTranscriptionOptions.md

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

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

1414
Create typed options for the generateTranscription() function without executing.
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/typescript/ai/src/activities/generateVideo/index.ts:488](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L488)
12+
Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:547](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L547)
1313

1414
Create typed options for the generateVideo() function without executing.
1515

docs/reference/functions/generateImage.md

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

12-
Defined in: [packages/typescript/ai/src/activities/generateImage/index.ts:167](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L167)
12+
Defined in: [packages/typescript/ai/src/activities/generateImage/index.ts:176](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L176)
1313

1414
Image activity - generates images from text prompts.
1515

docs/reference/functions/generateSpeech.md

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

12-
Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:119](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L119)
12+
Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:128](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L128)
1313

1414
TTS activity - generates speech from text.
1515

0 commit comments

Comments
 (0)