Open History to see the last commit
1{
2 "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
3 "docSearch": {
4 "appId": "FQ0DQ6MA3C",
5 "apiKey": "8264730bab8a9b7fa6a0c85761d7a3fe",
6 "indexName": "tanstack"
7 },
8 "sections": [
9 {
10 "label": "Getting Started",
11 "children": [
12 {
13 "label": "Overview",
14 "to": "getting-started/overview"
15 },
16 {
17 "label": "Quick Start",
18 "to": "getting-started/quick-start"
19 },
20 {
21 "label": "Devtools",
22 "to": "getting-started/devtools"
23 }
24 ]
25 },
26 {
27 "label": "Guides",
28 "children": [
29 {
30 "label": "Tools",
31 "to": "guides/tools"
32 },
33 {
34 "label": "Tool Architecture",
35 "to": "guides/tool-architecture"
36 },
37 {
38 "label": "Server Tools",
39 "to": "guides/server-tools"
40 },
41 {
42 "label": "Client Tools",
43 "to": "guides/client-tools"
44 },
45 {
46 "label": "Tool Approval Flow",
47 "to": "guides/tool-approval"
48 },
49 {
50 "label": "Agentic Cycle",
51 "to": "guides/agentic-cycle"
52 },
53 {
54 "label": "Streaming",
55 "to": "guides/streaming"
56 },
57 {
58 "label": "Multimodal Content",
59 "to": "guides/multimodal-content"
60 },
61 {
62 "label": "Connection Adapters",
63 "to": "guides/connection-adapters"
64 },
65 {
66 "label": "Observability",
67 "to": "guides/observability"
68 },
69 {
70 "label": "Per-Model Type Safety",
71 "to": "guides/per-model-type-safety"
72 },
73 {
74 "label": "Runtime Adapter Switching",
75 "to": "guides/runtime-adapter-switching"
76 },
77 {
78 "label": "Text-to-Speech",
79 "to": "guides/text-to-speech"
80 },
81 {
82 "label": "Transcription",
83 "to": "guides/transcription"
84 },
85 {
86 "label": "Image Generation",
87 "to": "guides/image-generation"
88 },
89 {
90 "label": "Video Generation",
91 "to": "guides/video-generation"
92 },
93 {
94 "label": "Tree-Shaking",
95 "to": "guides/tree-shaking"
96 },
97 {
98 "label": "Migration Guide",
99 "to": "guides/migration"
100 }
101 ]
102 },
103 {
104 "label": "API",
105 "children": [
106 {
107 "label": "@tanstack/ai",
108 "to": "api/ai"
109 },
110 {
111 "label": "@tanstack/ai-client",
112 "to": "api/ai-client"
113 },
114 {
115 "label": "@tanstack/ai-react",
116 "to": "api/ai-react"
117 },
118 {
119 "label": "@tanstack/ai-solid",
120 "to": "api/ai-solid"
121 }
122 ]
123 },
124 {
125 "label": "Adapters",
126 "children": [
127 {
128 "label": "OpenAI",
129 "to": "adapters/openai"
130 },
131 {
132 "label": "Anthropic",
133 "to": "adapters/anthropic"
134 },
135 {
136 "label": "Google Gemini",
137 "to": "adapters/gemini"
138 },
139 {
140 "label": "Ollama",
141 "to": "adapters/ollama"
142 }
143 ]
144 },
145 {
146 "label": "Class References",
147 "collapsible": true,
148 "defaultCollapsed": true,
149 "children": [
150 {
151 "label": "BaseAdapter",
152 "to": "reference/classes/BaseAdapter"
153 },
154 {
155 "label": "BatchStrategy",
156 "to": "reference/classes/BatchStrategy"
157 },
158 {
159 "label": "CompositeStrategy",
160 "to": "reference/classes/CompositeStrategy"
161 },
162 {
163 "label": "ImmediateStrategy",
164 "to": "reference/classes/ImmediateStrategy"
165 },
166 {
167 "label": "PartialJSONParser",
168 "to": "reference/classes/PartialJSONParser"
169 },
170 {
171 "label": "PunctuationStrategy",
172 "to": "reference/classes/PunctuationStrategy"
173 },
174 {
175 "label": "StreamProcessor",
176 "to": "reference/classes/StreamProcessor"
177 },
178 {
179 "label": "ToolCallManager",
180 "to": "reference/classes/ToolCallManager"
181 },
182 {
183 "label": "WordBoundaryStrategy",
184 "to": "reference/classes/WordBoundaryStrategy"
185 }
186 ]
187 },
188 {
189 "label": "Function References",
190 "collapsible": true,
191 "defaultCollapsed": true,
192 "children": [
193 {
194 "label": "text",
195 "to": "reference/functions/text"
196 },
197 {
198 "label": "textOptions",
199 "to": "reference/functions/textOptions"
200 },
201 {
202 "label": "combineStrategies",
203 "to": "reference/functions/combineStrategies"
204 },
205 {
206 "label": "convertMessagesToModelMessages",
207 "to": "reference/functions/convertMessagesToModelMessages"
208 },
209 {
210 "label": "convertZodToJsonSchema",
211 "to": "reference/functions/convertZodToJsonSchema"
212 },
213 {
214 "label": "createReplayStream",
215 "to": "reference/functions/createReplayStream"
216 },
217 {
218 "label": "embedding",
219 "to": "reference/functions/embedding"
220 },
221 {
222 "label": "generateMessageId",
223 "to": "reference/functions/generateMessageId"
224 },
225 {
226 "label": "maxIterations",
227 "to": "reference/functions/maxIterations"
228 },
229 {
230 "label": "messages",
231 "to": "reference/functions/messages"
232 },
233 {
234 "label": "modelMessageToUIMessage",
235 "to": "reference/functions/modelMessageToUIMessage"
236 },
237 {
238 "label": "modelMessagesToUIMessages",
239 "to": "reference/functions/modelMessagesToUIMessages"
240 },
241 {
242 "label": "normalizeToUIMessage",
243 "to": "reference/functions/normalizeToUIMessage"
244 },
245 {
246 "label": "parsePartialJSON",
247 "to": "reference/functions/parsePartialJSON"
248 },
249 {
250 "label": "summarize",
251 "to": "reference/functions/summarize"
252 },
253 {
254 "label": "toServerSentEventsStream",
255 "to": "reference/functions/toServerSentEventsStream"
256 },
257 {
258 "label": "toStreamResponse",
259 "to": "reference/functions/toStreamResponse"
260 },
261 {
262 "label": "toolDefinition",
263 "to": "reference/functions/toolDefinition"
264 },
265 {
266 "label": "uiMessageToModelMessages",
267 "to": "reference/functions/uiMessageToModelMessages"
268 },
269 {
270 "label": "untilFinishReason",
271 "to": "reference/functions/untilFinishReason"
272 }
273 ]
274 },
275 {
276 "label": "Interface References",
277 "collapsible": true,
278 "defaultCollapsed": true,
279 "children": [
280 {
281 "label": "AIAdapter",
282 "to": "reference/interfaces/AIAdapter"
283 },
284 {
285 "label": "AIAdapterConfig",
286 "to": "reference/interfaces/AIAdapterConfig"
287 },
288 {
289 "label": "AgentLoopState",
290 "to": "reference/interfaces/AgentLoopState"
291 },
292 {
293 "label": "ApprovalRequestedStreamChunk",
294 "to": "reference/interfaces/ApprovalRequestedStreamChunk"
295 },
296 {
297 "label": "AudioPart",
298 "to": "reference/interfaces/AudioPart"
299 },
300 {
301 "label": "BaseStreamChunk",
302 "to": "reference/interfaces/BaseStreamChunk"
303 },
304 {
305 "label": "TextCompletionChunk",
306 "to": "reference/interfaces/TextCompletionChunk"
307 },
308 {
309 "label": "TextOptions",
310 "to": "reference/interfaces/TextOptions"
311 },
312 {
313 "label": "ChunkRecording",
314 "to": "reference/interfaces/ChunkRecording"
315 },
316 {
317 "label": "ChunkStrategy",
318 "to": "reference/interfaces/ChunkStrategy"
319 },
320 {
321 "label": "ClientTool",
322 "to": "reference/interfaces/ClientTool"
323 },
324 {
325 "label": "ContentPartSource",
326 "to": "reference/interfaces/ContentPartSource"
327 },
328 {
329 "label": "ContentStreamChunk",
330 "to": "reference/interfaces/ContentStreamChunk"
331 },
332 {
333 "label": "DefaultMessageMetadataByModality",
334 "to": "reference/interfaces/DefaultMessageMetadataByModality"
335 },
336 {
337 "label": "DocumentPart",
338 "to": "reference/interfaces/DocumentPart"
339 },
340 {
341 "label": "DoneStreamChunk",
342 "to": "reference/interfaces/DoneStreamChunk"
343 },
344 {
345 "label": "EmbeddingOptions",
346 "to": "reference/interfaces/EmbeddingOptions"
347 },
348 {
349 "label": "EmbeddingResult",
350 "to": "reference/interfaces/EmbeddingResult"
351 },
352 {
353 "label": "ErrorStreamChunk",
354 "to": "reference/interfaces/ErrorStreamChunk"
355 },
356 {
357 "label": "ImagePart",
358 "to": "reference/interfaces/ImagePart"
359 },
360 {
361 "label": "InternalToolCallState",
362 "to": "reference/interfaces/InternalToolCallState"
363 },
364 {
365 "label": "JSONParser",
366 "to": "reference/interfaces/JSONParser"
367 },
368 {
369 "label": "ModelMessage",
370 "to": "reference/interfaces/ModelMessage"
371 },
372 {
373 "label": "ProcessorResult",
374 "to": "reference/interfaces/ProcessorResult"
375 },
376 {
377 "label": "ProcessorState",
378 "to": "reference/interfaces/ProcessorState"
379 },
380 {
381 "label": "ResponseFormat",
382 "to": "reference/interfaces/ResponseFormat"
383 },
384 {
385 "label": "ServerTool",
386 "to": "reference/interfaces/ServerTool"
387 },
388 {
389 "label": "StreamProcessorEvents",
390 "to": "reference/interfaces/StreamProcessorEvents"
391 },
392 {
393 "label": "StreamProcessorHandlers",
394 "to": "reference/interfaces/StreamProcessorHandlers"
395 },
396 {
397 "label": "StreamProcessorOptions",
398 "to": "reference/interfaces/StreamProcessorOptions"
399 },
400 {
401 "label": "SummarizationOptions",
402 "to": "reference/interfaces/SummarizationOptions"
403 },
404 {
405 "label": "SummarizationResult",
406 "to": "reference/interfaces/SummarizationResult"
407 },
408 {
409 "label": "TextPart",
410 "to": "reference/interfaces/TextPart"
411 },
412 {
413 "label": "ThinkingPart",
414 "to": "reference/interfaces/ThinkingPart"
415 },
416 {
417 "label": "ThinkingStreamChunk",
418 "to": "reference/interfaces/ThinkingStreamChunk"
419 },
420 {
421 "label": "Tool",
422 "to": "reference/interfaces/Tool"
423 },
424 {
425 "label": "ToolCall",
426 "to": "reference/interfaces/ToolCall"
427 },
428 {
429 "label": "ToolCallPart",
430 "to": "reference/interfaces/ToolCallPart"
431 },
432 {
433 "label": "ToolCallStreamChunk",
434 "to": "reference/interfaces/ToolCallStreamChunk"
435 },
436 {
437 "label": "ToolConfig",
438 "to": "reference/interfaces/ToolConfig"
439 },
440 {
441 "label": "ToolDefinition",
442 "to": "reference/interfaces/ToolDefinition"
443 },
444 {
445 "label": "ToolDefinitionConfig",
446 "to": "reference/interfaces/ToolDefinitionConfig"
447 },
448 {
449 "label": "ToolDefinitionInstance",
450 "to": "reference/interfaces/ToolDefinitionInstance"
451 },
452 {
453 "label": "ToolInputAvailableStreamChunk",
454 "to": "reference/interfaces/ToolInputAvailableStreamChunk"
455 },
456 {
457 "label": "ToolResultPart",
458 "to": "reference/interfaces/ToolResultPart"
459 },
460 {
461 "label": "ToolResultStreamChunk",
462 "to": "reference/interfaces/ToolResultStreamChunk"
463 },
464 {
465 "label": "UIMessage",
466 "to": "reference/interfaces/UIMessage"
467 },
468 {
469 "label": "VideoPart",
470 "to": "reference/interfaces/VideoPart"
471 }
472 ]
473 },
474 {
475 "label": "Type Alias References",
476 "collapsible": true,
477 "defaultCollapsed": true,
478 "children": [
479 {
480 "label": "AgentLoopStrategy",
481 "to": "reference/type-aliases/AgentLoopStrategy"
482 },
483 {
484 "label": "AnyClientTool",
485 "to": "reference/type-aliases/AnyClientTool"
486 },
487 {
488 "label": "TextStreamOptionsForModel",
489 "to": "reference/type-aliases/TextStreamOptionsForModel"
490 },
491 {
492 "label": "TextStreamOptionsUnion",
493 "to": "reference/type-aliases/TextStreamOptionsUnion"
494 },
495 {
496 "label": "ConstrainedContent",
497 "to": "reference/type-aliases/ConstrainedContent"
498 },
499 {
500 "label": "ConstrainedModelMessage",
501 "to": "reference/type-aliases/ConstrainedModelMessage"
502 },
503 {
504 "label": "ContentPart",
505 "to": "reference/type-aliases/ContentPart"
506 },
507 {
508 "label": "ContentPartForModalities",
509 "to": "reference/type-aliases/ContentPartForModalities"
510 },
511 {
512 "label": "ExtractModalitiesForModel",
513 "to": "reference/type-aliases/ExtractModalitiesForModel"
514 },
515 {
516 "label": "ExtractModelsFromAdapter",
517 "to": "reference/type-aliases/ExtractModelsFromAdapter"
518 },
519 {
520 "label": "InferToolInput",
521 "to": "reference/type-aliases/InferToolInput"
522 },
523 {
524 "label": "InferToolName",
525 "to": "reference/type-aliases/InferToolName"
526 },
527 {
528 "label": "InferToolOutput",
529 "to": "reference/type-aliases/InferToolOutput"
530 },
531 {
532 "label": "MessagePart",
533 "to": "reference/type-aliases/MessagePart"
534 },
535 {
536 "label": "ModalitiesArrayToUnion",
537 "to": "reference/type-aliases/ModalitiesArrayToUnion"
538 },
539 {
540 "label": "Modality",
541 "to": "reference/type-aliases/Modality"
542 },
543 {
544 "label": "StreamChunk",
545 "to": "reference/type-aliases/StreamChunk"
546 },
547 {
548 "label": "StreamChunkType",
549 "to": "reference/type-aliases/StreamChunkType"
550 },
551 {
552 "label": "ToolCallState",
553 "to": "reference/type-aliases/ToolCallState"
554 },
555 {
556 "label": "ToolResultState",
557 "to": "reference/type-aliases/ToolResultState"
558 }
559 ]
560 },
561 {
562 "label": "Variable References",
563 "collapsible": true,
564 "defaultCollapsed": true,
565 "children": [
566 {
567 "label": "aiEventClient",
568 "to": "reference/variables/aiEventClient"
569 },
570 {
571 "label": "defaultJSONParser",
572 "to": "reference/variables/defaultJSONParser"
573 }
574 ]
575 }
576 ]
577}