Skip to content
Open
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
6 changes: 3 additions & 3 deletions docs/reference/classes/MCPDuplicateToolNameError.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: MCPDuplicateToolNameError
title: MCPDuplicateToolNameError
---

Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L31)
Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L66)

## Extends

Expand All @@ -17,7 +17,7 @@ Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:31](https://github.c
new MCPDuplicateToolNameError(toolName): MCPDuplicateToolNameError;
```

Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L32)
Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L67)

#### Parameters

Expand All @@ -43,4 +43,4 @@ Error.constructor
readonly toolName: string;
```

Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L32)
Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L67)
44 changes: 22 additions & 22 deletions docs/reference/classes/StreamProcessor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: StreamProcessor
title: StreamProcessor
---

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:237](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L237)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:238](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L238)

StreamProcessor - State machine for processing AI response streams

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:306](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L306)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:307](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L307)

#### Parameters

Expand All @@ -50,7 +50,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:306](https://gi
addToolApprovalResponse(approvalId, approved): void;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:498](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L498)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:499](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L499)

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

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L447)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:448](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L448)

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

Expand Down Expand Up @@ -112,7 +112,7 @@ addUserMessage(
metadata?): UIMessage;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:386](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L386)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:387](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L387)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:538](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L538)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:539](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L539)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:628](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L628)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:629](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L629)

Clear all messages

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3454](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3454)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3478](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3478)

Finalize the stream — complete all pending operations.

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:431](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L431)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:432](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L432)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:530](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L530)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:531](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L531)

Get current messages

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3626](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3626)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3650](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3650)

Get the current recording

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3583](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3583)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3607](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3607)

Get current processor state (aggregated across all messages)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:421](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L421)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:422](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L422)

Prepare for a new assistant message stream.
Does NOT create the message immediately -- the message is created lazily
Expand All @@ -310,7 +310,7 @@ auto-continuation produces no content.
prependMessages(messages): void;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:347](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L347)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:348](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L348)

Put older UI messages at the front of the conversation.

Expand Down Expand Up @@ -346,7 +346,7 @@ processor.prependMessages([oldest])
process(stream): Promise<ProcessorResult>;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:654](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L654)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:655](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L655)

Process a stream and emit events through handlers

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:688](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L688)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:689](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L689)

Process a single chunk from the stream.

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:578](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L578)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:579](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L579)

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

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3657](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3657)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3681](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3681)

Full reset (including messages)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:326](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L326)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:327](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L327)

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

Expand All @@ -458,7 +458,7 @@ Set the messages array (e.g., from persisted state)
startRecording(): void;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3613](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3613)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3637](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3637)

Start recording chunks

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:519](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L519)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:520](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L520)

Get the conversation as ModelMessages (for sending to LLM)

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

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3678](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3678)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3702](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3702)

Replay a recording through the processor

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: chat
function chat<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware, TAgents>(options): TextActivityResult<TSchema, TStream, TTools>;
```

Defined in: [packages/ai/src/activities/chat/index.ts:6220](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L6220)
Defined in: [packages/ai/src/activities/chat/index.ts:6302](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L6302)

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/createReplayStream.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: createReplayStream
function createReplayStream(recording): AsyncIterable<AGUIEvent>;
```

Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3690](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3690)
Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3714](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3714)

Create an async iterable from a recording

Expand Down
25 changes: 25 additions & 0 deletions docs/reference/functions/stableJson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: stableJson
title: stableJson
---

```ts
function stableJson(value): string;
```

Defined in: [packages/ai/src/utilities/stable-json.ts:7](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/stable-json.ts#L7)

JSON text with the keys of every object in sorted order. Arrays keep their
order. A store can give a value back with its keys in another order
(PostgreSQL `jsonb` does, and so does a schema parse), so compare or hash
this, not `JSON.stringify`, when the value went through a store.

## Parameters

### value

`unknown`

## Returns

`string`
3 changes: 3 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,8 @@ title: "@tanstack/ai"
- [KnownCustomEvent](type-aliases/KnownCustomEvent.md)
- [LoadChild](type-aliases/LoadChild.md)
- [MCPConnectionPolicy](type-aliases/MCPConnectionPolicy.md)
- [MCPRequestMeta](type-aliases/MCPRequestMeta.md)
- [MCPRequestMetaInput](type-aliases/MCPRequestMetaInput.md)
- [MediaInputRole](type-aliases/MediaInputRole.md)
- [MediaPrompt](type-aliases/MediaPrompt.md)
- [MediaPromptFor](type-aliases/MediaPromptFor.md)
Expand Down Expand Up @@ -616,6 +618,7 @@ title: "@tanstack/ai"
- [runAgentStream](functions/runAgentStream.md)
- [score](functions/score.md)
- [splitMidConversationChanges](functions/splitMidConversationChanges.md)
- [stableJson](functions/stableJson.md)
- [streamToText](functions/streamToText.md)
- [subagentHostMessageId](functions/subagentHostMessageId.md)
- [subagentInputOf](functions/subagentInputOf.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/interfaces/ActivityDeltaEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: ActivityDeltaEvent
title: ActivityDeltaEvent
---

Defined in: [packages/ai/src/types.ts:2088](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2088)
Defined in: [packages/ai/src/types.ts:2103](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2103)

RFC 6902 JSON Patch against an existing activity's `content`.

Expand All @@ -22,4 +22,4 @@ RFC 6902 JSON Patch against an existing activity's `content`.
type: "ACTIVITY_DELTA";
```

Defined in: [packages/ai/src/types.ts:2092](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2092)
Defined in: [packages/ai/src/types.ts:2107](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2107)
4 changes: 2 additions & 2 deletions docs/reference/interfaces/ActivitySnapshotEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: ActivitySnapshotEvent
title: ActivitySnapshotEvent
---

Defined in: [packages/ai/src/types.ts:2075](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2075)
Defined in: [packages/ai/src/types.ts:2090](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2090)

Full activity state for an `ActivityMessage`.

Expand All @@ -22,4 +22,4 @@ Full activity state for an `ActivityMessage`.
type: "ACTIVITY_SNAPSHOT";
```

Defined in: [packages/ai/src/types.ts:2079](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2079)
Defined in: [packages/ai/src/types.ts:2094](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2094)
12 changes: 6 additions & 6 deletions docs/reference/interfaces/AgentLoopState.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: AgentLoopState
title: AgentLoopState
---

Defined in: [packages/ai/src/types.ts:1248](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1248)
Defined in: [packages/ai/src/types.ts:1263](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1263)

State passed to agent loop strategy for determining whether to continue

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

Defined in: [packages/ai/src/types.ts:1254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1254)
Defined in: [packages/ai/src/types.ts:1269](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1269)

Finish reason from the last response

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

Defined in: [packages/ai/src/types.ts:1250](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1250)
Defined in: [packages/ai/src/types.ts:1265](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1265)

Current iteration count (0-indexed). One iteration = one model turn.

Expand All @@ -39,7 +39,7 @@ Current iteration count (0-indexed). One iteration = one model turn.
lastTurnToolCallCount: number;
```

Defined in: [packages/ai/src/types.ts:1266](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1266)
Defined in: [packages/ai/src/types.ts:1281](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1281)

Tool calls in the most recent batch — a live model turn or a
pending/resume batch (0 when the last phase produced no tool calls).
Expand All @@ -55,7 +55,7 @@ messages: ModelMessage<
| null>[];
```

Defined in: [packages/ai/src/types.ts:1252](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1252)
Defined in: [packages/ai/src/types.ts:1267](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1267)

Current messages array

Expand All @@ -67,7 +67,7 @@ Current messages array
toolCallCount: number;
```

Defined in: [packages/ai/src/types.ts:1261](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1261)
Defined in: [packages/ai/src/types.ts:1276](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1276)

Cumulative tool calls counted so far in this run (model-emitted during the
agent loop, including ones skipped by middleware, and pending tools from
Expand Down
Loading