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

Defined in: [packages/ai/src/activities/chat/index.ts:2666](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2666)
Defined in: [packages/ai/src/activities/chat/index.ts:2686](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L2686)

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, TTools, TMiddleware>(options): TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>;
```

Defined in: [packages/ai/src/activities/chat/index.ts:340](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L340)
Defined in: [packages/ai/src/activities/chat/index.ts:341](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L341)

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/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/ai/src/activities/generateTranscription/index.ts:292](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L292)
Defined in: [packages/ai/src/activities/generateTranscription/index.ts:296](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L296)

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

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/ai/src/activities/generateTranscription/index.ts:160](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L160)
Defined in: [packages/ai/src/activities/generateTranscription/index.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L164)

Transcription activity - converts audio to text.

Expand Down
17 changes: 17 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ title: "@tanstack/ai"
- [ChunkRecording](interfaces/ChunkRecording.md)
- [ChunkStrategy](interfaces/ChunkStrategy.md)
- [ClientTool](interfaces/ClientTool.md)
- [CodeModeConsoleEvent](interfaces/CodeModeConsoleEvent.md)
- [CodeModeExecutionStartedEvent](interfaces/CodeModeExecutionStartedEvent.md)
- [CodeModeExternalCallEvent](interfaces/CodeModeExternalCallEvent.md)
- [CodeModeExternalErrorEvent](interfaces/CodeModeExternalErrorEvent.md)
- [CodeModeExternalResultEvent](interfaces/CodeModeExternalResultEvent.md)
- [CodeModeSkillCallEvent](interfaces/CodeModeSkillCallEvent.md)
- [CodeModeSkillErrorEvent](interfaces/CodeModeSkillErrorEvent.md)
- [CodeModeSkillResultEvent](interfaces/CodeModeSkillResultEvent.md)
- [ContentPartDataSource](interfaces/ContentPartDataSource.md)
- [ContentPartUrlSource](interfaces/ContentPartUrlSource.md)
- [CustomEvent](interfaces/CustomEvent.md)
Expand All @@ -52,6 +60,7 @@ title: "@tanstack/ai"
- [DocumentPart](interfaces/DocumentPart.md)
- [ErrorInfo](interfaces/ErrorInfo.md)
- [ExtendedModelDef](interfaces/ExtendedModelDef.md)
- [FileChangedEvent](interfaces/FileChangedEvent.md)
- [FinishInfo](interfaces/FinishInfo.md)
- [GenerationAbortInfo](interfaces/GenerationAbortInfo.md)
- [GenerationErrorInfo](interfaces/GenerationErrorInfo.md)
Expand Down Expand Up @@ -104,8 +113,13 @@ title: "@tanstack/ai"
- [RunErrorEvent](interfaces/RunErrorEvent.md)
- [RunFinishedEvent](interfaces/RunFinishedEvent.md)
- [RunStartedEvent](interfaces/RunStartedEvent.md)
- [SandboxFileCustomEvent](interfaces/SandboxFileCustomEvent.md)
- [SandboxFileDiffEvent](interfaces/SandboxFileDiffEvent.md)
- [SandboxFileEvent](interfaces/SandboxFileEvent.md)
- [SandboxFileHookEvent](interfaces/SandboxFileHookEvent.md)
- [ServerTool](interfaces/ServerTool.md)
- [SessionIdEvent](interfaces/SessionIdEvent.md)
- [SkillRegisteredEvent](interfaces/SkillRegisteredEvent.md)
- [StateDeltaEvent](interfaces/StateDeltaEvent.md)
- [StateSnapshotEvent](interfaces/StateSnapshotEvent.md)
- [StepFinishedEvent](interfaces/StepFinishedEvent.md)
Expand Down Expand Up @@ -185,6 +199,7 @@ title: "@tanstack/ai"
- [CapabilityHandle](type-aliases/CapabilityHandle.md)
- [CapabilityProvider](type-aliases/CapabilityProvider.md)
- [ChatMiddlewarePhase](type-aliases/ChatMiddlewarePhase.md)
- [ChatStream](type-aliases/ChatStream.md)
- [ConstrainedContent](type-aliases/ConstrainedContent.md)
- [ConstrainedModelMessage](type-aliases/ConstrainedModelMessage.md)
- [ContentPart](type-aliases/ContentPart.md)
Expand All @@ -201,6 +216,7 @@ title: "@tanstack/ai"
- [InferToolName](type-aliases/InferToolName.md)
- [InferToolOutput](type-aliases/InferToolOutput.md)
- [InputModalitiesTypes](type-aliases/InputModalitiesTypes.md)
- [KnownCustomEvent](type-aliases/KnownCustomEvent.md)
- [MCPConnectionPolicy](type-aliases/MCPConnectionPolicy.md)
- [MediaInputRole](type-aliases/MediaInputRole.md)
- [MediaPrompt](type-aliases/MediaPrompt.md)
Expand All @@ -227,6 +243,7 @@ title: "@tanstack/ai"
- [ToolExecutionContext](type-aliases/ToolExecutionContext.md)
- [ToolOutputState](type-aliases/ToolOutputState.md)
- [ToolResultState](type-aliases/ToolResultState.md)
- [TranscriptionResponseFormat](type-aliases/TranscriptionResponseFormat.md)
- [~~UsageTotals~~](type-aliases/UsageTotals.md)
- [WireMessage](type-aliases/WireMessage.md)

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/interfaces/AbortInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AbortInfo

# Interface: AbortInfo

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:358](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L358)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:371](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L371)

Information passed to onAbort.

Expand All @@ -17,7 +17,7 @@ Information passed to onAbort.
duration: number;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:362](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L362)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:375](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L375)

Duration until abort in milliseconds

Expand All @@ -29,6 +29,6 @@ Duration until abort in milliseconds
optional reason: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:360](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L360)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:373](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L373)

The reason for the abort, if provided
18 changes: 9 additions & 9 deletions docs/reference/interfaces/AfterToolCallInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AfterToolCallInfo

# Interface: AfterToolCallInfo

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L258)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:271](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L271)

Outcome information provided to onAfterToolCall.

Expand All @@ -17,7 +17,7 @@ Outcome information provided to onAfterToolCall.
duration: number;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:270](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L270)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:283](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L283)

Duration of tool execution in milliseconds

Expand All @@ -29,7 +29,7 @@ Duration of tool execution in milliseconds
optional error: unknown;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:273](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L273)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:286](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L286)

***

Expand All @@ -39,7 +39,7 @@ Defined in: [packages/ai/src/activities/chat/middleware/types.ts:273](https://gi
ok: boolean;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:268](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L268)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:281](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L281)

Whether the execution succeeded

Expand All @@ -51,7 +51,7 @@ Whether the execution succeeded
optional result: unknown;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:272](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L272)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:285](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L285)

The result (if ok) or error (if not ok)

Expand All @@ -65,7 +65,7 @@ tool:
| undefined;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:262](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L262)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:275](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L275)

The resolved tool definition

Expand All @@ -77,7 +77,7 @@ The resolved tool definition
toolCall: ToolCall;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:260](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L260)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:273](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L273)

The tool call that was executed

Expand All @@ -89,7 +89,7 @@ The tool call that was executed
toolCallId: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:266](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L266)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:279](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L279)

ID of the tool call

Expand All @@ -101,6 +101,6 @@ ID of the tool call
toolName: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:264](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L264)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:277](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L277)

Name of the tool
12 changes: 6 additions & 6 deletions docs/reference/interfaces/AudioGenerationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AudioGenerationOptions

# Interface: AudioGenerationOptions\<TProviderOptions\>

Defined in: [packages/ai/src/types.ts:1742](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1742)
Defined in: [packages/ai/src/types.ts:1841](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1841)

Options for audio generation (music, sound effects, etc.).
These are the common options supported across providers.
Expand All @@ -24,7 +24,7 @@ These are the common options supported across providers.
optional duration: number;
```

Defined in: [packages/ai/src/types.ts:1750](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1750)
Defined in: [packages/ai/src/types.ts:1849](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1849)

Desired duration in seconds

Expand All @@ -36,7 +36,7 @@ Desired duration in seconds
logger: InternalLogger;
```

Defined in: [packages/ai/src/types.ts:1758](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1758)
Defined in: [packages/ai/src/types.ts:1857](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1857)

Internal logger threaded from the generateAudio() entry point. Adapters
must call logger.request() before the SDK call and logger.errors() in
Expand All @@ -50,7 +50,7 @@ catch blocks.
model: string;
```

Defined in: [packages/ai/src/types.ts:1746](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1746)
Defined in: [packages/ai/src/types.ts:1845](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1845)

The model to use for audio generation

Expand All @@ -62,7 +62,7 @@ The model to use for audio generation
optional modelOptions: TProviderOptions;
```

Defined in: [packages/ai/src/types.ts:1752](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1752)
Defined in: [packages/ai/src/types.ts:1851](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1851)

Model-specific options for audio generation

Expand All @@ -74,6 +74,6 @@ Model-specific options for audio generation
prompt: string;
```

Defined in: [packages/ai/src/types.ts:1748](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1748)
Defined in: [packages/ai/src/types.ts:1847](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1847)

Text description of the desired audio
10 changes: 5 additions & 5 deletions docs/reference/interfaces/AudioGenerationResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AudioGenerationResult

# Interface: AudioGenerationResult

Defined in: [packages/ai/src/types.ts:1774](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1774)
Defined in: [packages/ai/src/types.ts:1873](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1873)

Result of audio generation

Expand All @@ -17,7 +17,7 @@ Result of audio generation
audio: GeneratedAudio;
```

Defined in: [packages/ai/src/types.ts:1780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1780)
Defined in: [packages/ai/src/types.ts:1879](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1879)

The generated audio

Expand All @@ -29,7 +29,7 @@ The generated audio
id: string;
```

Defined in: [packages/ai/src/types.ts:1776](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1776)
Defined in: [packages/ai/src/types.ts:1875](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1875)

Unique identifier for the generation

Expand All @@ -41,7 +41,7 @@ Unique identifier for the generation
model: string;
```

Defined in: [packages/ai/src/types.ts:1778](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1778)
Defined in: [packages/ai/src/types.ts:1877](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1877)

Model used for generation

Expand All @@ -53,6 +53,6 @@ Model used for generation
optional usage: TokenUsage<ProviderUsageDetails>;
```

Defined in: [packages/ai/src/types.ts:1782](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1782)
Defined in: [packages/ai/src/types.ts:1881](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1881)

Token usage information (if available)
Loading