Skip to content

docs: regenerate API documentation #479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlemTuzlak merged 1 commit into from
Apr 20, 2026
Merged

docs: regenerate API documentation #479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/reference/classes/BatchStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: BatchStrategy

# Class: BatchStrategy

Defined in: [activities/chat/stream/strategies.ts:34](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L34)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:34](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L34)

Batch Strategy - emit every N chunks
Useful for reducing UI update frequency
Expand All @@ -22,7 +22,7 @@ Useful for reducing UI update frequency
new BatchStrategy(batchSize): BatchStrategy;
```

Defined in: [activities/chat/stream/strategies.ts:37](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L37)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:37](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L37)

#### Parameters

Expand All @@ -42,7 +42,7 @@ Defined in: [activities/chat/stream/strategies.ts:37](https://github.com/TanStac
reset(): void;
```

Defined in: [activities/chat/stream/strategies.ts:48](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L48)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:48](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L48)

Optional: Reset strategy state (called when streaming starts)

Expand All @@ -62,7 +62,7 @@ Optional: Reset strategy state (called when streaming starts)
shouldEmit(_chunk, _accumulated): boolean;
```

Defined in: [activities/chat/stream/strategies.ts:39](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L39)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:39](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L39)

Called for each text chunk received

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/CompositeStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: CompositeStrategy

# Class: CompositeStrategy

Defined in: [activities/chat/stream/strategies.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L68)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L68)

Composite Strategy - combine multiple strategies (OR logic)
Emits if ANY strategy says to emit
Expand All @@ -22,7 +22,7 @@ Emits if ANY strategy says to emit
new CompositeStrategy(strategies): CompositeStrategy;
```

Defined in: [activities/chat/stream/strategies.ts:69](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L69)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:69](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L69)

#### Parameters

Expand All @@ -42,7 +42,7 @@ Defined in: [activities/chat/stream/strategies.ts:69](https://github.com/TanStac
reset(): void;
```

Defined in: [activities/chat/stream/strategies.ts:75](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L75)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:75](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L75)

Optional: Reset strategy state (called when streaming starts)

Expand All @@ -62,7 +62,7 @@ Optional: Reset strategy state (called when streaming starts)
shouldEmit(chunk, accumulated): boolean;
```

Defined in: [activities/chat/stream/strategies.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L71)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L71)

Called for each text chunk received

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/ImmediateStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: ImmediateStrategy

# Class: ImmediateStrategy

Defined in: [activities/chat/stream/strategies.ts:12](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L12)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:12](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L12)

Immediate Strategy - emit on every chunk (default behavior)

Expand Down Expand Up @@ -33,7 +33,7 @@ new ImmediateStrategy(): ImmediateStrategy;
shouldEmit(_chunk, _accumulated): boolean;
```

Defined in: [activities/chat/stream/strategies.ts:13](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L13)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:13](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L13)

Called for each text chunk received

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/PartialJSONParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: PartialJSONParser

# Class: PartialJSONParser

Defined in: [activities/chat/stream/json-parser.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/json-parser.ts#L25)
Defined in: [packages/typescript/ai/src/activities/chat/stream/json-parser.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/json-parser.ts#L25)

Partial JSON Parser implementation using the partial-json library
This parser can handle incomplete JSON strings during streaming
Expand Down Expand Up @@ -34,7 +34,7 @@ new PartialJSONParser(): PartialJSONParser;
parse(jsonString): any;
```

Defined in: [activities/chat/stream/json-parser.ts:31](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/json-parser.ts#L31)
Defined in: [packages/typescript/ai/src/activities/chat/stream/json-parser.ts:31](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/json-parser.ts#L31)

Parse a potentially incomplete JSON string

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/PunctuationStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: PunctuationStrategy

# Class: PunctuationStrategy

Defined in: [activities/chat/stream/strategies.ts:22](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L22)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:22](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L22)

Punctuation Strategy - emit when chunk contains punctuation
Useful for natural text flow in UI
Expand Down Expand Up @@ -34,7 +34,7 @@ new PunctuationStrategy(): PunctuationStrategy;
shouldEmit(chunk, _accumulated): boolean;
```

Defined in: [activities/chat/stream/strategies.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L25)
Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L25)

Called for each text chunk received

Expand Down
46 changes: 23 additions & 23 deletions docs/reference/classes/StreamProcessor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: StreamProcessor

# Class: StreamProcessor

Defined in: [activities/chat/stream/processor.ts:128](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L128)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:128](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L128)

StreamProcessor - State machine for processing AI response streams

Expand All @@ -32,7 +32,7 @@ State tracking:
new StreamProcessor(options): StreamProcessor;
```

Defined in: [activities/chat/stream/processor.ts:155](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L155)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:155](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L155)

#### Parameters

Expand All @@ -52,7 +52,7 @@ Defined in: [activities/chat/stream/processor.ts:155](https://github.com/TanStac
addToolApprovalResponse(approvalId, approved): void;
```

Defined in: [activities/chat/stream/processor.ts:313](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L313)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:313](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L313)

Add an approval response (called by client after handling onApprovalRequest)

Expand Down Expand Up @@ -81,7 +81,7 @@ addToolResult(
error?): void;
```

Defined in: [activities/chat/stream/processor.ts:269](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L269)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:269](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L269)

Add a tool result (called by client after handling onToolCall)

Expand Down Expand Up @@ -111,7 +111,7 @@ Add a tool result (called by client after handling onToolCall)
addUserMessage(content, id?): UIMessage;
```

Defined in: [activities/chat/stream/processor.ts:202](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L202)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:202](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L202)

Add a user message to the conversation.
Supports both simple string content and multimodal content arrays.
Expand Down Expand Up @@ -160,7 +160,7 @@ processor.addUserMessage('Hello!', 'custom-id-123')
areAllToolsComplete(): boolean;
```

Defined in: [activities/chat/stream/processor.ts:344](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L344)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:344](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L344)

Check if all tool calls in the last assistant message are complete
Useful for auto-continue logic
Expand All @@ -177,7 +177,7 @@ Useful for auto-continue logic
clearMessages(): void;
```

Defined in: [activities/chat/stream/processor.ts:388](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L388)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:388](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L388)

Clear all messages

Expand All @@ -193,7 +193,7 @@ Clear all messages
finalizeStream(): void;
```

Defined in: [activities/chat/stream/processor.ts:1317](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1317)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1444](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1444)

Finalize the stream — complete all pending operations.

Expand All @@ -217,7 +217,7 @@ docs/chat-architecture.md#single-shot-text-response — Finalization step
getCurrentAssistantMessageId(): string | null;
```

Defined in: [activities/chat/stream/processor.ts:253](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L253)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:253](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L253)

Get the current assistant message ID (if one has been created).
Returns null if prepareAssistantMessage() was called but no content
Expand All @@ -235,7 +235,7 @@ has arrived yet.
getMessages(): UIMessage[];
```

Defined in: [activities/chat/stream/processor.ts:336](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L336)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:336](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L336)

Get current messages

Expand All @@ -251,7 +251,7 @@ Get current messages
getRecording(): ChunkRecording | null;
```

Defined in: [activities/chat/stream/processor.ts:1449](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1449)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1576](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1576)

Get the current recording

Expand All @@ -267,7 +267,7 @@ Get the current recording
getState(): ProcessorState;
```

Defined in: [activities/chat/stream/processor.ts:1408](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1408)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1535](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1535)

Get current processor state (aggregated across all messages)

Expand All @@ -283,7 +283,7 @@ Get current processor state (aggregated across all messages)
prepareAssistantMessage(): void;
```

Defined in: [activities/chat/stream/processor.ts:232](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L232)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:232](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L232)

Prepare for a new assistant message stream.
Does NOT create the message immediately -- the message is created lazily
Expand All @@ -303,7 +303,7 @@ auto-continuation produces no content.
process(stream): Promise<ProcessorResult>;
```

Defined in: [activities/chat/stream/processor.ts:404](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L404)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:404](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L404)

Process a stream and emit events through handlers

Expand All @@ -325,13 +325,13 @@ Process a stream and emit events through handlers
processChunk(chunk): void;
```

Defined in: [activities/chat/stream/processor.ts:438](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L438)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:438](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L438)

Process a single chunk from the stream.

Central dispatch for all AG-UI events. Each event type maps to a specific
handler. Events not listed in the switch are intentionally ignored
(RUN_STARTED, STEP_STARTED, STATE_DELTA).
(STEP_STARTED, STATE_SNAPSHOT, STATE_DELTA).

#### Parameters

Expand All @@ -355,7 +355,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering
removeMessagesAfter(index): void;
```

Defined in: [activities/chat/stream/processor.ts:380](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L380)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:380](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L380)

Remove messages after a certain index (for reload/retry)

Expand All @@ -377,7 +377,7 @@ Remove messages after a certain index (for reload/retry)
reset(): void;
```

Defined in: [activities/chat/stream/processor.ts:1471](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1471)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1598](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1598)

Full reset (including messages)

Expand All @@ -393,7 +393,7 @@ Full reset (including messages)
setMessages(messages): void;
```

Defined in: [activities/chat/stream/processor.ts:174](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L174)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:174](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L174)

Set the messages array (e.g., from persisted state)

Expand All @@ -415,7 +415,7 @@ Set the messages array (e.g., from persisted state)
startAssistantMessage(messageId?): string;
```

Defined in: [activities/chat/stream/processor.ts:241](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L241)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:241](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L241)

#### Parameters

Expand All @@ -440,7 +440,7 @@ an assistant message which can cause empty message flicker.
startRecording(): void;
```

Defined in: [activities/chat/stream/processor.ts:1436](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1436)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1563](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1563)

Start recording chunks

Expand All @@ -459,7 +459,7 @@ toModelMessages(): ModelMessage<
| null>[];
```

Defined in: [activities/chat/stream/processor.ts:325](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L325)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:325](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L325)

Get the conversation as ModelMessages (for sending to LLM)

Expand All @@ -478,7 +478,7 @@ Get the conversation as ModelMessages (for sending to LLM)
static replay(recording, options?): Promise<ProcessorResult>;
```

Defined in: [activities/chat/stream/processor.ts:1490](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1490)
Defined in: [packages/typescript/ai/src/activities/chat/stream/processor.ts:1617](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L1617)

Replay a recording through the processor

Expand Down
Loading