Skip to content

Commit f2ded50

Browse files
docs: regenerate API documentation (#902)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 084c9e4 commit f2ded50

78 files changed

Lines changed: 1628 additions & 275 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/functions/chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: chat
99
function chat<TAdapter, TSchema, TStream, TTools, TMiddleware>(options): TextActivityResult<TSchema, TStream>;
1010
```
1111

12-
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)
12+
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)
1313

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

docs/reference/functions/createChatOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createChatOptions
99
function createChatOptions<TAdapter, TSchema, TStream, TTools, TMiddleware>(options): TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Create typed options for the chat() function without executing.
1515
This is useful for pre-defining configurations with full type inference.

docs/reference/functions/createTranscriptionOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createTranscriptionOptions
99
function createTranscriptionOptions<TAdapter, TStream>(options): TranscriptionActivityOptions<TAdapter, TStream>;
1010
```
1111

12-
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)
12+
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)
1313

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

docs/reference/functions/generateTranscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: generateTranscription
99
function generateTranscription<TAdapter, TStream>(options): TranscriptionActivityResult<TStream>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Transcription activity - converts audio to text.
1515

docs/reference/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ title: "@tanstack/ai"
4242
- [ChunkRecording](interfaces/ChunkRecording.md)
4343
- [ChunkStrategy](interfaces/ChunkStrategy.md)
4444
- [ClientTool](interfaces/ClientTool.md)
45+
- [CodeModeConsoleEvent](interfaces/CodeModeConsoleEvent.md)
46+
- [CodeModeExecutionStartedEvent](interfaces/CodeModeExecutionStartedEvent.md)
47+
- [CodeModeExternalCallEvent](interfaces/CodeModeExternalCallEvent.md)
48+
- [CodeModeExternalErrorEvent](interfaces/CodeModeExternalErrorEvent.md)
49+
- [CodeModeExternalResultEvent](interfaces/CodeModeExternalResultEvent.md)
50+
- [CodeModeSkillCallEvent](interfaces/CodeModeSkillCallEvent.md)
51+
- [CodeModeSkillErrorEvent](interfaces/CodeModeSkillErrorEvent.md)
52+
- [CodeModeSkillResultEvent](interfaces/CodeModeSkillResultEvent.md)
4553
- [ContentPartDataSource](interfaces/ContentPartDataSource.md)
4654
- [ContentPartUrlSource](interfaces/ContentPartUrlSource.md)
4755
- [CustomEvent](interfaces/CustomEvent.md)
@@ -52,6 +60,7 @@ title: "@tanstack/ai"
5260
- [DocumentPart](interfaces/DocumentPart.md)
5361
- [ErrorInfo](interfaces/ErrorInfo.md)
5462
- [ExtendedModelDef](interfaces/ExtendedModelDef.md)
63+
- [FileChangedEvent](interfaces/FileChangedEvent.md)
5564
- [FinishInfo](interfaces/FinishInfo.md)
5665
- [GenerationAbortInfo](interfaces/GenerationAbortInfo.md)
5766
- [GenerationErrorInfo](interfaces/GenerationErrorInfo.md)
@@ -104,8 +113,13 @@ title: "@tanstack/ai"
104113
- [RunErrorEvent](interfaces/RunErrorEvent.md)
105114
- [RunFinishedEvent](interfaces/RunFinishedEvent.md)
106115
- [RunStartedEvent](interfaces/RunStartedEvent.md)
116+
- [SandboxFileCustomEvent](interfaces/SandboxFileCustomEvent.md)
117+
- [SandboxFileDiffEvent](interfaces/SandboxFileDiffEvent.md)
107118
- [SandboxFileEvent](interfaces/SandboxFileEvent.md)
119+
- [SandboxFileHookEvent](interfaces/SandboxFileHookEvent.md)
108120
- [ServerTool](interfaces/ServerTool.md)
121+
- [SessionIdEvent](interfaces/SessionIdEvent.md)
122+
- [SkillRegisteredEvent](interfaces/SkillRegisteredEvent.md)
109123
- [StateDeltaEvent](interfaces/StateDeltaEvent.md)
110124
- [StateSnapshotEvent](interfaces/StateSnapshotEvent.md)
111125
- [StepFinishedEvent](interfaces/StepFinishedEvent.md)
@@ -185,6 +199,7 @@ title: "@tanstack/ai"
185199
- [CapabilityHandle](type-aliases/CapabilityHandle.md)
186200
- [CapabilityProvider](type-aliases/CapabilityProvider.md)
187201
- [ChatMiddlewarePhase](type-aliases/ChatMiddlewarePhase.md)
202+
- [ChatStream](type-aliases/ChatStream.md)
188203
- [ConstrainedContent](type-aliases/ConstrainedContent.md)
189204
- [ConstrainedModelMessage](type-aliases/ConstrainedModelMessage.md)
190205
- [ContentPart](type-aliases/ContentPart.md)
@@ -201,6 +216,7 @@ title: "@tanstack/ai"
201216
- [InferToolName](type-aliases/InferToolName.md)
202217
- [InferToolOutput](type-aliases/InferToolOutput.md)
203218
- [InputModalitiesTypes](type-aliases/InputModalitiesTypes.md)
219+
- [KnownCustomEvent](type-aliases/KnownCustomEvent.md)
204220
- [MCPConnectionPolicy](type-aliases/MCPConnectionPolicy.md)
205221
- [MediaInputRole](type-aliases/MediaInputRole.md)
206222
- [MediaPrompt](type-aliases/MediaPrompt.md)
@@ -227,6 +243,7 @@ title: "@tanstack/ai"
227243
- [ToolExecutionContext](type-aliases/ToolExecutionContext.md)
228244
- [ToolOutputState](type-aliases/ToolOutputState.md)
229245
- [ToolResultState](type-aliases/ToolResultState.md)
246+
- [TranscriptionResponseFormat](type-aliases/TranscriptionResponseFormat.md)
230247
- [~~UsageTotals~~](type-aliases/UsageTotals.md)
231248
- [WireMessage](type-aliases/WireMessage.md)
232249

docs/reference/interfaces/AbortInfo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AbortInfo
55

66
# Interface: AbortInfo
77

8-
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)
8+
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)
99

1010
Information passed to onAbort.
1111

@@ -17,7 +17,7 @@ Information passed to onAbort.
1717
duration: number;
1818
```
1919

20-
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)
20+
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)
2121

2222
Duration until abort in milliseconds
2323

@@ -29,6 +29,6 @@ Duration until abort in milliseconds
2929
optional reason: string;
3030
```
3131

32-
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)
32+
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)
3333

3434
The reason for the abort, if provided

docs/reference/interfaces/AfterToolCallInfo.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AfterToolCallInfo
55

66
# Interface: AfterToolCallInfo
77

8-
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)
8+
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)
99

1010
Outcome information provided to onAfterToolCall.
1111

@@ -17,7 +17,7 @@ Outcome information provided to onAfterToolCall.
1717
duration: number;
1818
```
1919

20-
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)
20+
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)
2121

2222
Duration of tool execution in milliseconds
2323

@@ -29,7 +29,7 @@ Duration of tool execution in milliseconds
2929
optional error: unknown;
3030
```
3131

32-
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)
32+
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)
3333

3434
***
3535

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

42-
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)
42+
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)
4343

4444
Whether the execution succeeded
4545

@@ -51,7 +51,7 @@ Whether the execution succeeded
5151
optional result: unknown;
5252
```
5353

54-
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)
54+
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)
5555

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

@@ -65,7 +65,7 @@ tool:
6565
| undefined;
6666
```
6767

68-
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)
68+
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)
6969

7070
The resolved tool definition
7171

@@ -77,7 +77,7 @@ The resolved tool definition
7777
toolCall: ToolCall;
7878
```
7979

80-
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)
80+
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)
8181

8282
The tool call that was executed
8383

@@ -89,7 +89,7 @@ The tool call that was executed
8989
toolCallId: string;
9090
```
9191

92-
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)
92+
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)
9393

9494
ID of the tool call
9595

@@ -101,6 +101,6 @@ ID of the tool call
101101
toolName: string;
102102
```
103103

104-
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)
104+
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)
105105

106106
Name of the tool

docs/reference/interfaces/AudioGenerationOptions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AudioGenerationOptions
55

66
# Interface: AudioGenerationOptions\<TProviderOptions\>
77

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

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

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

2929
Desired duration in seconds
3030

@@ -36,7 +36,7 @@ Desired duration in seconds
3636
logger: InternalLogger;
3737
```
3838

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

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

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

5555
The model to use for audio generation
5656

@@ -62,7 +62,7 @@ The model to use for audio generation
6262
optional modelOptions: TProviderOptions;
6363
```
6464

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

6767
Model-specific options for audio generation
6868

@@ -74,6 +74,6 @@ Model-specific options for audio generation
7474
prompt: string;
7575
```
7676

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

7979
Text description of the desired audio

docs/reference/interfaces/AudioGenerationResult.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AudioGenerationResult
55

66
# Interface: AudioGenerationResult
77

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

1010
Result of audio generation
1111

@@ -17,7 +17,7 @@ Result of audio generation
1717
audio: GeneratedAudio;
1818
```
1919

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

2222
The generated audio
2323

@@ -29,7 +29,7 @@ The generated audio
2929
id: string;
3030
```
3131

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

3434
Unique identifier for the generation
3535

@@ -41,7 +41,7 @@ Unique identifier for the generation
4141
model: string;
4242
```
4343

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

4646
Model used for generation
4747

@@ -53,6 +53,6 @@ Model used for generation
5353
optional usage: TokenUsage<ProviderUsageDetails>;
5454
```
5555

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

5858
Token usage information (if available)

0 commit comments

Comments
 (0)