Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions docs/reference/classes/ConsoleLogger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
---
id: ConsoleLogger
title: ConsoleLogger
---

# Class: ConsoleLogger

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)

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.

## Implements

- [`Logger`](../interfaces/Logger.md)

## Constructors

### Constructor

```ts
new ConsoleLogger(): ConsoleLogger;
```

#### Returns

`ConsoleLogger`

## Methods

### debug()

```ts
debug(message, meta?): void;
```

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)

Log a debug-level message; forwards to `console.debug`.

#### Parameters

##### message

`string`

##### meta?

`Record`\<`string`, `unknown`\>

#### Returns

`void`

#### Implementation of

[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug)

***

### error()

```ts
error(message, meta?): void;
```

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)

Log an error-level message; forwards to `console.error`.

#### Parameters

##### message

`string`

##### meta?

`Record`\<`string`, `unknown`\>

#### Returns

`void`

#### Implementation of

[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error)

***

### info()

```ts
info(message, meta?): void;
```

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)

Log an info-level message; forwards to `console.info`.

#### Parameters

##### message

`string`

##### meta?

`Record`\<`string`, `unknown`\>

#### Returns

`void`

#### Implementation of

[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info)

***

### warn()

```ts
warn(message, meta?): void;
```

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)

Log a warning-level message; forwards to `console.warn`.

#### Parameters

##### message

`string`

##### meta?

`Record`\<`string`, `unknown`\>

#### Returns

`void`

#### Implementation of

[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn)
2 changes: 1 addition & 1 deletion docs/reference/functions/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: chat
function chat<TAdapter, TSchema, TStream>(options): TextActivityResult<TSchema, TStream>;
```

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)
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)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createChatOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createChatOptions
function createChatOptions<TAdapter, TSchema, TStream>(options): TextActivityOptions<TAdapter, TSchema, TStream>;
```

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)
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)

Create typed options for the chat() function without executing.
This is useful for pre-defining configurations with full type inference.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createImageOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createImageOptions
function createImageOptions<TAdapter, TStream>(options): ImageActivityOptions<TAdapter, TStream>;
```

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)
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)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createSpeechOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createSpeechOptions
function createSpeechOptions<TAdapter, TStream>(options): TTSActivityOptions<TAdapter, TStream>;
```

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)
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)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createSummarizeOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createSummarizeOptions
function createSummarizeOptions<TAdapter, TStream>(options): SummarizeActivityOptions<TAdapter, TStream>;
```

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)
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)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createTranscriptionOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createTranscriptionOptions
function createTranscriptionOptions<TAdapter, TStream>(options): TranscriptionActivityOptions<TAdapter, TStream>;
```

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)
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)

Create typed options for the generateTranscription() function without executing.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/createVideoOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: createVideoOptions
function createVideoOptions<TAdapter, TStream>(options): VideoCreateOptions<TAdapter, TStream>;
```

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)
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)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/generateImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateImage
function generateImage<TAdapter, TStream>(options): ImageActivityResult<TStream>;
```

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)
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)

Image activity - generates images from text prompts.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/generateSpeech.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateSpeech
function generateSpeech<TAdapter, TStream>(options): TTSActivityResult<TStream>;
```

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)
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)

TTS activity - generates speech from text.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/generateTranscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateTranscription
function generateTranscription<TAdapter, TStream>(options): TranscriptionActivityResult<TStream>;
```

Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:134](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L134)
Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:143](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L143)

Transcription activity - converts audio to text.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/generateVideo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateVideo
function generateVideo<TAdapter, TStream>(options): TStream extends true ? AsyncIterable<AGUIEvent, any, any> : Promise<VideoJobResult>;
```

Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:221](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L221)
Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:230](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L230)

**`Experimental`**

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/getVideoJobStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function getVideoJobStatus<TAdapter>(options): Promise<{
}>;
```

Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:388](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L388)
Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:447](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L447)

**`Experimental`**

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/summarize.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: summarize
function summarize<TAdapter, TStream>(options): SummarizeActivityResult<TStream>;
```

Defined in: [packages/typescript/ai/src/activities/summarize/index.ts:147](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/index.ts#L147)
Defined in: [packages/typescript/ai/src/activities/summarize/index.ts:156](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/index.ts#L156)

Summarize activity - generates summaries from text.

Expand Down
5 changes: 5 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ title: "@tanstack/ai"

- [BatchStrategy](classes/BatchStrategy.md)
- [CompositeStrategy](classes/CompositeStrategy.md)
- [ConsoleLogger](classes/ConsoleLogger.md)
- [ImmediateStrategy](classes/ImmediateStrategy.md)
- [PartialJSONParser](classes/PartialJSONParser.md)
- [PunctuationStrategy](classes/PunctuationStrategy.md)
Expand All @@ -33,6 +34,8 @@ title: "@tanstack/ai"
- [ContentPartDataSource](interfaces/ContentPartDataSource.md)
- [ContentPartUrlSource](interfaces/ContentPartUrlSource.md)
- [CustomEvent](interfaces/CustomEvent.md)
- [DebugCategories](interfaces/DebugCategories.md)
- [DebugConfig](interfaces/DebugConfig.md)
- [DefaultMessageMetadataByModality](interfaces/DefaultMessageMetadataByModality.md)
- [DocumentPart](interfaces/DocumentPart.md)
- [ErrorInfo](interfaces/ErrorInfo.md)
Expand All @@ -47,6 +50,7 @@ title: "@tanstack/ai"
- [IterationInfo](interfaces/IterationInfo.md)
- [JSONParser](interfaces/JSONParser.md)
- [JSONSchema](interfaces/JSONSchema.md)
- [Logger](interfaces/Logger.md)
- [MessagesSnapshotEvent](interfaces/MessagesSnapshotEvent.md)
- [ModelMessage](interfaces/ModelMessage.md)
- [ProcessorResult](interfaces/ProcessorResult.md)
Expand Down Expand Up @@ -146,6 +150,7 @@ title: "@tanstack/ai"
- [ContentPart](type-aliases/ContentPart.md)
- [ContentPartForInputModalitiesTypes](type-aliases/ContentPartForInputModalitiesTypes.md)
- [ContentPartSource](type-aliases/ContentPartSource.md)
- [DebugOption](type-aliases/DebugOption.md)
- [InferSchemaType](type-aliases/InferSchemaType.md)
- [InferToolInput](type-aliases/InferToolInput.md)
- [InferToolName](type-aliases/InferToolName.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/interfaces/AgentLoopState.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AgentLoopState

# Interface: AgentLoopState

Defined in: [packages/typescript/ai/src/types.ts:630](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L630)
Defined in: [packages/typescript/ai/src/types.ts:631](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L631)

State passed to agent loop strategy for determining whether to continue

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

Defined in: [packages/typescript/ai/src/types.ts:636](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L636)
Defined in: [packages/typescript/ai/src/types.ts:637](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L637)

Finish reason from the last response

Expand All @@ -29,7 +29,7 @@ Finish reason from the last response
iterationCount: number;
```

Defined in: [packages/typescript/ai/src/types.ts:632](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L632)
Defined in: [packages/typescript/ai/src/types.ts:633](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L633)

Current iteration count (0-indexed)

Expand All @@ -44,6 +44,6 @@ messages: ModelMessage<
| null>[];
```

Defined in: [packages/typescript/ai/src/types.ts:634](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L634)
Defined in: [packages/typescript/ai/src/types.ts:635](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L635)

Current messages array
8 changes: 4 additions & 4 deletions docs/reference/interfaces/AudioPart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AudioPart

# Interface: AudioPart\<TMetadata\>

Defined in: [packages/typescript/ai/src/types.ts:201](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L201)
Defined in: [packages/typescript/ai/src/types.ts:202](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L202)

Audio content part for multimodal messages.

Expand All @@ -25,7 +25,7 @@ Provider-specific metadata type
optional metadata: TMetadata;
```

Defined in: [packages/typescript/ai/src/types.ts:206](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L206)
Defined in: [packages/typescript/ai/src/types.ts:207](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L207)

Provider-specific metadata (e.g., format, sample rate)

Expand All @@ -37,7 +37,7 @@ Provider-specific metadata (e.g., format, sample rate)
source: ContentPartSource;
```

Defined in: [packages/typescript/ai/src/types.ts:204](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L204)
Defined in: [packages/typescript/ai/src/types.ts:205](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L205)

Source of the audio content

Expand All @@ -49,4 +49,4 @@ Source of the audio content
type: "audio";
```

Defined in: [packages/typescript/ai/src/types.ts:202](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L202)
Defined in: [packages/typescript/ai/src/types.ts:203](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L203)
4 changes: 2 additions & 2 deletions docs/reference/interfaces/BaseAGUIEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: BaseAGUIEvent

# Interface: BaseAGUIEvent

Defined in: [packages/typescript/ai/src/types.ts:785](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L785)
Defined in: [packages/typescript/ai/src/types.ts:794](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L794)

Base structure for AG-UI events.
Extends @ag-ui/core BaseEvent with TanStack AI additions.
Expand All @@ -31,6 +31,6 @@ TanStack AI adds: `model?`
optional model: string;
```

Defined in: [packages/typescript/ai/src/types.ts:787](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L787)
Defined in: [packages/typescript/ai/src/types.ts:796](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L796)

Model identifier for multi-model support
Loading