docs: regenerate API documentation (#267)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: github-actions[bot]

docs/reference/classes/StreamProcessor.md

@@ -5,7 +5,7 @@ title: StreamProcessor
 
 # Class: StreamProcessor
 
-Defined in: [activities/chat/stream/processor.ts:114](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L114)
+Defined in: [activities/chat/stream/processor.ts:115](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L115)
 
 StreamProcessor - State machine for processing AI response streams
 
@@ -31,7 +31,7 @@ Tool call completion is detected when:
 new StreamProcessor(options): StreamProcessor;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:142](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L142)
+Defined in: [activities/chat/stream/processor.ts:143](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L143)
 
 #### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [activities/chat/stream/processor.ts:142](https://github.com/TanStac
 addToolApprovalResponse(approvalId, approved): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:255](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L255)
+Defined in: [activities/chat/stream/processor.ts:256](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L256)
 
 Add an approval response (called by client after handling onApprovalRequest)
 
@@ -80,7 +80,7 @@ addToolResult(
    error?): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:211](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L211)
+Defined in: [activities/chat/stream/processor.ts:212](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L212)
 
 Add a tool result (called by client after handling onToolCall)
 
@@ -110,7 +110,7 @@ Add a tool result (called by client after handling onToolCall)
 addUserMessage(content): UIMessage;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:169](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L169)
+Defined in: [activities/chat/stream/processor.ts:170](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L170)
 
 Add a user message to the conversation
 
@@ -132,7 +132,7 @@ Add a user message to the conversation
 areAllToolsComplete(): boolean;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:286](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L286)
+Defined in: [activities/chat/stream/processor.ts:287](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L287)
 
 Check if all tool calls in the last assistant message are complete
 Useful for auto-continue logic
@@ -149,7 +149,7 @@ Useful for auto-continue logic
 clearMessages(): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:318](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L318)
+Defined in: [activities/chat/stream/processor.ts:331](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L331)
 
 Clear all messages
 
@@ -165,7 +165,7 @@ Clear all messages
 finalizeStream(): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:814](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L814)
+Defined in: [activities/chat/stream/processor.ts:827](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L827)
 
 Finalize the stream - complete all pending operations
 
@@ -181,7 +181,7 @@ Finalize the stream - complete all pending operations
 getMessages(): UIMessage[];
 ```
 
-Defined in: [activities/chat/stream/processor.ts:278](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L278)
+Defined in: [activities/chat/stream/processor.ts:279](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L279)
 
 Get current messages
 
@@ -197,7 +197,7 @@ Get current messages
 getRecording(): ChunkRecording | null;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:893](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L893)
+Defined in: [activities/chat/stream/processor.ts:906](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L906)
 
 Get the current recording
 
@@ -213,7 +213,7 @@ Get the current recording
 getState(): ProcessorState;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:866](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L866)
+Defined in: [activities/chat/stream/processor.ts:879](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L879)
 
 Get current processor state
 
@@ -229,7 +229,7 @@ Get current processor state
 process(stream): Promise<ProcessorResult>;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:331](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L331)
+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)
 
 Process a stream and emit events through handlers
 
@@ -251,7 +251,7 @@ Process a stream and emit events through handlers
 processChunk(chunk): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:359](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L359)
+Defined in: [activities/chat/stream/processor.ts:372](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L372)
 
 Process a single chunk from the stream
 
@@ -273,7 +273,7 @@ Process a single chunk from the stream
 removeMessagesAfter(index): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:310](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L310)
+Defined in: [activities/chat/stream/processor.ts:323](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L323)
 
 Remove messages after a certain index (for reload/retry)
 
@@ -295,7 +295,7 @@ Remove messages after a certain index (for reload/retry)
 reset(): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:916](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L916)
+Defined in: [activities/chat/stream/processor.ts:929](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L929)
 
 Full reset (including messages)
 
@@ -311,7 +311,7 @@ Full reset (including messages)
 setMessages(messages): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:161](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L161)
+Defined in: [activities/chat/stream/processor.ts:162](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L162)
 
 Set the messages array (e.g., from persisted state)
 
@@ -333,7 +333,7 @@ Set the messages array (e.g., from persisted state)
 startAssistantMessage(): string;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:187](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L187)
+Defined in: [activities/chat/stream/processor.ts:188](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L188)
 
 Start streaming a new assistant message
 Returns the message ID
@@ -350,7 +350,7 @@ Returns the message ID
 startRecording(): void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:880](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L880)
+Defined in: [activities/chat/stream/processor.ts:893](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L893)
 
 Start recording chunks
 
@@ -369,7 +369,7 @@ toModelMessages(): ModelMessage<
   | null>[];
 ```
 
-Defined in: [activities/chat/stream/processor.ts:267](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L267)
+Defined in: [activities/chat/stream/processor.ts:268](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L268)
 
 Get the conversation as ModelMessages (for sending to LLM)
 
@@ -388,7 +388,7 @@ Get the conversation as ModelMessages (for sending to LLM)
 static replay(recording, options?): Promise<ProcessorResult>;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:925](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L925)
+Defined in: [activities/chat/stream/processor.ts:938](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L938)
 
 Replay a recording through the processor
 

docs/reference/functions/chat.md

@@ -9,7 +9,7 @@ title: chat
 function chat<TAdapter, TSchema, TStream>(options): TextActivityResult<TSchema, TStream>;
 ```
 
-Defined in: [activities/chat/index.ts:1052](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L1052)
+Defined in: [activities/chat/index.ts:1122](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L1122)
 
 Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.
 

docs/reference/functions/createChatOptions.md

@@ -9,7 +9,7 @@ title: createChatOptions
 function createChatOptions<TAdapter, TSchema, TStream>(options): TextActivityOptions<TAdapter, TSchema, TStream>;
 ```
 
-Defined in: [activities/chat/index.ts:152](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L152)
+Defined in: [activities/chat/index.ts:153](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L153)
 
 Create typed options for the chat() function without executing.
 This is useful for pre-defining configurations with full type inference.

docs/reference/functions/createReplayStream.md

@@ -9,7 +9,7 @@ title: createReplayStream
 function createReplayStream(recording): AsyncIterable<AGUIEvent>;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:937](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L937)
+Defined in: [activities/chat/stream/processor.ts:950](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L950)
 
 Create an async iterable from a recording
 

docs/reference/functions/generateMessageId.md

@@ -9,7 +9,7 @@ title: generateMessageId
 function generateMessageId(): string;
 ```
 
-Defined in: [activities/chat/messages.ts:280](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L280)
+Defined in: [activities/chat/messages.ts:319](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L319)
 
 Generate a unique message ID
 

docs/reference/functions/modelMessageToUIMessage.md

@@ -9,7 +9,7 @@ title: modelMessageToUIMessage
 function modelMessageToUIMessage(modelMessage, id?): UIMessage;
 ```
 
-Defined in: [activities/chat/messages.ts:155](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L155)
+Defined in: [activities/chat/messages.ts:194](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L194)
 
 Convert a ModelMessage to UIMessage
 

docs/reference/functions/modelMessagesToUIMessages.md

@@ -9,7 +9,7 @@ title: modelMessagesToUIMessages
 function modelMessagesToUIMessages(modelMessages): UIMessage[];
 ```
 
-Defined in: [activities/chat/messages.ts:208](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L208)
+Defined in: [activities/chat/messages.ts:247](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L247)
 
 Convert an array of ModelMessages to UIMessages
 

docs/reference/functions/normalizeToUIMessage.md

@@ -9,7 +9,7 @@ title: normalizeToUIMessage
 function normalizeToUIMessage(message, generateId): UIMessage;
 ```
 
-Defined in: [activities/chat/messages.ts:257](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L257)
+Defined in: [activities/chat/messages.ts:296](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/messages.ts#L296)
 
 Normalize a message (UIMessage or ModelMessage) to a UIMessage
 Ensures the message has an ID and createdAt timestamp

docs/reference/interfaces/StreamProcessorEvents.md

@@ -5,7 +5,7 @@ title: StreamProcessorEvents
 
 # Interface: StreamProcessorEvents
 
-Defined in: [activities/chat/stream/processor.ts:48](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L48)
+Defined in: [activities/chat/stream/processor.ts:49](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L49)
 
 Events emitted by the StreamProcessor
 
@@ -17,7 +17,7 @@ Events emitted by the StreamProcessor
 optional onApprovalRequest: (args) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:63](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L63)
+Defined in: [activities/chat/stream/processor.ts:64](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L64)
 
 #### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [activities/chat/stream/processor.ts:63](https://github.com/TanStack
 optional onError: (error) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L55)
+Defined in: [activities/chat/stream/processor.ts:56](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L56)
 
 #### Parameters
 
@@ -71,7 +71,7 @@ Defined in: [activities/chat/stream/processor.ts:55](https://github.com/TanStack
 optional onMessagesChange: (messages) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:50](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L50)
+Defined in: [activities/chat/stream/processor.ts:51](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L51)
 
 #### Parameters
 
@@ -91,7 +91,7 @@ Defined in: [activities/chat/stream/processor.ts:50](https://github.com/TanStack
 optional onStreamEnd: (message) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:54](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L54)
+Defined in: [activities/chat/stream/processor.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L55)
 
 #### Parameters
 
@@ -111,7 +111,7 @@ Defined in: [activities/chat/stream/processor.ts:54](https://github.com/TanStack
 optional onStreamStart: () => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:53](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L53)
+Defined in: [activities/chat/stream/processor.ts:54](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L54)
 
 #### Returns
 
@@ -125,7 +125,7 @@ Defined in: [activities/chat/stream/processor.ts:53](https://github.com/TanStack
 optional onTextUpdate: (messageId, content) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L71)
+Defined in: [activities/chat/stream/processor.ts:72](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L72)
 
 #### Parameters
 
@@ -149,7 +149,7 @@ Defined in: [activities/chat/stream/processor.ts:71](https://github.com/TanStack
 optional onThinkingUpdate: (messageId, content) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:78](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L78)
+Defined in: [activities/chat/stream/processor.ts:79](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L79)
 
 #### Parameters
 
@@ -173,7 +173,7 @@ Defined in: [activities/chat/stream/processor.ts:78](https://github.com/TanStack
 optional onToolCall: (args) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:58](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L58)
+Defined in: [activities/chat/stream/processor.ts:59](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L59)
 
 #### Parameters
 
@@ -203,7 +203,7 @@ Defined in: [activities/chat/stream/processor.ts:58](https://github.com/TanStack
 optional onToolCallStateChange: (messageId, toolCallId, state, args) => void;
 ```
 
-Defined in: [activities/chat/stream/processor.ts:72](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L72)
+Defined in: [activities/chat/stream/processor.ts:73](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L73)
 
 #### Parameters