Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

config.json

841 lines21.5 KB

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: React",
18 "to": "getting-started/quick-start"
19 },
20 {
21 "label": "Devtools",
22 "to": "getting-started/devtools"
23 },
24 {
25 "label": "Quick Start: Vue",
26 "to": "getting-started/quick-start-vue"
27 },
28 {
29 "label": "Quick Start: Svelte",
30 "to": "getting-started/quick-start-svelte"
31 },
32 {
33 "label": "Quick Start: Server Only",
34 "to": "getting-started/quick-start-server"
35 },
36 {
37 "label": "Agent Skills (TanStack Intent)",
38 "to": "getting-started/agent-skills"
39 }
40 ]
41 },
42 {
43 "label": "Comparison",
44 "children": [
45 {
46 "label": "TanStack AI vs Vercel AI SDK",
47 "to": "comparison/vercel-ai-sdk"
48 }
49 ]
50 },
51 {
52 "label": "Tools",
53 "children": [
54 {
55 "label": "Tools",
56 "to": "tools/tools"
57 },
58 {
59 "label": "Provider Tools",
60 "to": "tools/provider-tools"
61 },
62 {
63 "label": "Tool Architecture",
64 "to": "tools/tool-architecture"
65 },
66 {
67 "label": "Server Tools",
68 "to": "tools/server-tools"
69 },
70 {
71 "label": "Client Tools",
72 "to": "tools/client-tools"
73 },
74 {
75 "label": "Tool Approval Flow",
76 "to": "tools/tool-approval"
77 },
78 {
79 "label": "Lazy Tool Discovery",
80 "to": "tools/lazy-tool-discovery"
81 }
82 ]
83 },
84 {
85 "label": "Chat & Streaming",
86 "children": [
87 {
88 "label": "Agentic Cycle",
89 "to": "chat/agentic-cycle"
90 },
91 {
92 "label": "Streaming",
93 "to": "chat/streaming"
94 },
95 {
96 "label": "Connection Adapters",
97 "to": "chat/connection-adapters"
98 },
99 {
100 "label": "Thinking & Reasoning",
101 "to": "chat/thinking-content"
102 }
103 ]
104 },
105 {
106 "label": "Structured Outputs",
107 "children": [
108 {
109 "label": "Overview",
110 "to": "structured-outputs/overview"
111 },
112 {
113 "label": "One-Shot Extraction",
114 "to": "structured-outputs/one-shot"
115 },
116 {
117 "label": "Streaming UIs",
118 "to": "structured-outputs/streaming"
119 },
120 {
121 "label": "Multi-Turn Chat",
122 "to": "structured-outputs/multi-turn"
123 },
124 {
125 "label": "With Tools",
126 "to": "structured-outputs/with-tools"
127 }
128 ]
129 },
130 {
131 "label": "Code Mode",
132 "children": [
133 {
134 "label": "Code Mode",
135 "to": "code-mode/code-mode"
136 },
137 {
138 "label": "Showing Code Mode in the UI",
139 "to": "code-mode/client-integration"
140 },
141 {
142 "label": "Code Mode with Skills",
143 "to": "code-mode/code-mode-with-skills"
144 },
145 {
146 "label": "Code Mode Isolate Drivers",
147 "to": "code-mode/code-mode-isolates"
148 }
149 ]
150 },
151 {
152 "label": "Media",
153 "children": [
154 {
155 "label": "Generations",
156 "to": "media/generations"
157 },
158 {
159 "label": "Realtime Voice Chat",
160 "to": "media/realtime-chat"
161 },
162 {
163 "label": "Text-to-Speech",
164 "to": "media/text-to-speech"
165 },
166 {
167 "label": "Transcription",
168 "to": "media/transcription"
169 },
170 {
171 "label": "Audio Generation",
172 "to": "media/audio-generation"
173 },
174 {
175 "label": "Image Generation",
176 "to": "media/image-generation"
177 },
178 {
179 "label": "Video Generation",
180 "to": "media/video-generation"
181 },
182 {
183 "label": "Generation Hooks",
184 "to": "media/generation-hooks"
185 }
186 ]
187 },
188 {
189 "label": "Advanced",
190 "children": [
191 {
192 "label": "Middleware",
193 "to": "advanced/middleware"
194 },
195 {
196 "label": "Debug Logging",
197 "to": "advanced/debug-logging"
198 },
199 {
200 "label": "OpenTelemetry",
201 "to": "advanced/otel"
202 },
203 {
204 "label": "Observability",
205 "to": "advanced/observability"
206 },
207 {
208 "label": "Multimodal Content",
209 "to": "advanced/multimodal-content"
210 },
211 {
212 "label": "Per-Model Type Safety",
213 "to": "advanced/per-model-type-safety"
214 },
215 {
216 "label": "Runtime Adapter Switching",
217 "to": "advanced/runtime-adapter-switching"
218 },
219 {
220 "label": "Tree-Shaking",
221 "to": "advanced/tree-shaking"
222 },
223 {
224 "label": "Extend Adapter",
225 "to": "advanced/extend-adapter"
226 }
227 ]
228 },
229 {
230 "label": "Migration",
231 "children": [
232 {
233 "label": "Migration Guide",
234 "to": "migration/migration"
235 },
236 {
237 "label": "From Vercel AI SDK",
238 "to": "migration/migration-from-vercel-ai"
239 },
240 {
241 "label": "AG-UI Client Compliance",
242 "to": "migration/ag-ui-compliance"
243 }
244 ]
245 },
246 {
247 "label": "API",
248 "children": [
249 {
250 "label": "@tanstack/ai",
251 "to": "api/ai"
252 },
253 {
254 "label": "@tanstack/ai-client",
255 "to": "api/ai-client"
256 },
257 {
258 "label": "@tanstack/ai-react",
259 "to": "api/ai-react"
260 },
261 {
262 "label": "@tanstack/ai-solid",
263 "to": "api/ai-solid"
264 },
265 {
266 "label": "@tanstack/ai-preact",
267 "to": "api/ai-preact"
268 },
269 {
270 "label": "@tanstack/ai-vue",
271 "to": "api/ai-vue"
272 },
273 {
274 "label": "@tanstack/ai-svelte",
275 "to": "api/ai-svelte"
276 }
277 ]
278 },
279 {
280 "label": "Adapters",
281 "children": [
282 {
283 "label": "OpenAI",
284 "to": "adapters/openai"
285 },
286 {
287 "label": "Anthropic",
288 "to": "adapters/anthropic"
289 },
290 {
291 "label": "Google Gemini",
292 "to": "adapters/gemini"
293 },
294 {
295 "label": "Ollama",
296 "to": "adapters/ollama"
297 },
298 {
299 "label": "Grok (xAI)",
300 "to": "adapters/grok"
301 },
302 {
303 "label": "Groq",
304 "to": "adapters/groq"
305 },
306 {
307 "label": "ElevenLabs",
308 "to": "adapters/elevenlabs"
309 },
310 {
311 "label": "fal.ai",
312 "to": "adapters/fal"
313 },
314 {
315 "label": "OpenRouter Adapter",
316 "to": "adapters/openrouter"
317 }
318 ]
319 },
320 {
321 "label": "Community Adapters",
322 "children": [
323 {
324 "label": "Community Adapters Guide",
325 "to": "community-adapters/guide"
326 },
327 {
328 "label": "Decart",
329 "to": "community-adapters/decart"
330 },
331 {
332 "label": "Cencori",
333 "to": "community-adapters/cencori"
334 },
335 {
336 "label": "Cloudflare",
337 "to": "community-adapters/cloudflare"
338 },
339 {
340 "label": "Soniox",
341 "to": "community-adapters/soniox"
342 },
343 {
344 "label": "Mynth",
345 "to": "community-adapters/mynth"
346 }
347 ]
348 },
349 {
350 "label": "Class References",
351 "collapsible": true,
352 "defaultCollapsed": true,
353 "children": [
354 {
355 "label": "BaseAdapter",
356 "to": "reference/classes/BaseAdapter"
357 },
358 {
359 "label": "BatchStrategy",
360 "to": "reference/classes/BatchStrategy"
361 },
362 {
363 "label": "CompositeStrategy",
364 "to": "reference/classes/CompositeStrategy"
365 },
366 {
367 "label": "ImmediateStrategy",
368 "to": "reference/classes/ImmediateStrategy"
369 },
370 {
371 "label": "PartialJSONParser",
372 "to": "reference/classes/PartialJSONParser"
373 },
374 {
375 "label": "PunctuationStrategy",
376 "to": "reference/classes/PunctuationStrategy"
377 },
378 {
379 "label": "StreamProcessor",
380 "to": "reference/classes/StreamProcessor"
381 },
382 {
383 "label": "ToolCallManager",
384 "to": "reference/classes/ToolCallManager"
385 },
386 {
387 "label": "RealtimeClient",
388 "to": "reference/classes/RealtimeClient"
389 },
390 {
391 "label": "WordBoundaryStrategy",
392 "to": "reference/classes/WordBoundaryStrategy"
393 }
394 ]
395 },
396 {
397 "label": "Function References",
398 "collapsible": true,
399 "defaultCollapsed": true,
400 "children": [
401 {
402 "label": "text",
403 "to": "reference/functions/text"
404 },
405 {
406 "label": "textOptions",
407 "to": "reference/functions/textOptions"
408 },
409 {
410 "label": "combineStrategies",
411 "to": "reference/functions/combineStrategies"
412 },
413 {
414 "label": "convertMessagesToModelMessages",
415 "to": "reference/functions/convertMessagesToModelMessages"
416 },
417 {
418 "label": "convertZodToJsonSchema",
419 "to": "reference/functions/convertZodToJsonSchema"
420 },
421 {
422 "label": "createReplayStream",
423 "to": "reference/functions/createReplayStream"
424 },
425 {
426 "label": "embedding",
427 "to": "reference/functions/embedding"
428 },
429 {
430 "label": "generateMessageId",
431 "to": "reference/functions/generateMessageId"
432 },
433 {
434 "label": "maxIterations",
435 "to": "reference/functions/maxIterations"
436 },
437 {
438 "label": "messages",
439 "to": "reference/functions/messages"
440 },
441 {
442 "label": "modelMessageToUIMessage",
443 "to": "reference/functions/modelMessageToUIMessage"
444 },
445 {
446 "label": "modelMessagesToUIMessages",
447 "to": "reference/functions/modelMessagesToUIMessages"
448 },
449 {
450 "label": "normalizeToUIMessage",
451 "to": "reference/functions/normalizeToUIMessage"
452 },
453 {
454 "label": "parsePartialJSON",
455 "to": "reference/functions/parsePartialJSON"
456 },
457 {
458 "label": "summarize",
459 "to": "reference/functions/summarize"
460 },
461 {
462 "label": "toServerSentEventsStream",
463 "to": "reference/functions/toServerSentEventsStream"
464 },
465 {
466 "label": "toServerSentEventsResponse",
467 "to": "reference/functions/toServerSentEventsResponse"
468 },
469 {
470 "label": "toolDefinition",
471 "to": "reference/functions/toolDefinition"
472 },
473 {
474 "label": "uiMessageToModelMessages",
475 "to": "reference/functions/uiMessageToModelMessages"
476 },
477 {
478 "label": "realtimeToken",
479 "to": "reference/functions/realtimeToken"
480 },
481 {
482 "label": "untilFinishReason",
483 "to": "reference/functions/untilFinishReason"
484 }
485 ]
486 },
487 {
488 "label": "Interface References",
489 "collapsible": true,
490 "defaultCollapsed": true,
491 "children": [
492 {
493 "label": "AIAdapter",
494 "to": "reference/interfaces/AIAdapter"
495 },
496 {
497 "label": "AIAdapterConfig",
498 "to": "reference/interfaces/AIAdapterConfig"
499 },
500 {
501 "label": "AgentLoopState",
502 "to": "reference/interfaces/AgentLoopState"
503 },
504 {
505 "label": "ApprovalRequestedStreamChunk",
506 "to": "reference/interfaces/ApprovalRequestedStreamChunk"
507 },
508 {
509 "label": "AudioPart",
510 "to": "reference/interfaces/AudioPart"
511 },
512 {
513 "label": "AudioVisualization",
514 "to": "reference/interfaces/AudioVisualization"
515 },
516 {
517 "label": "BaseStreamChunk",
518 "to": "reference/interfaces/BaseStreamChunk"
519 },
520 {
521 "label": "TextCompletionChunk",
522 "to": "reference/interfaces/TextCompletionChunk"
523 },
524 {
525 "label": "TextOptions",
526 "to": "reference/interfaces/TextOptions"
527 },
528 {
529 "label": "ChunkRecording",
530 "to": "reference/interfaces/ChunkRecording"
531 },
532 {
533 "label": "ChunkStrategy",
534 "to": "reference/interfaces/ChunkStrategy"
535 },
536 {
537 "label": "ClientTool",
538 "to": "reference/interfaces/ClientTool"
539 },
540 {
541 "label": "ContentPartSource",
542 "to": "reference/interfaces/ContentPartSource"
543 },
544 {
545 "label": "ContentStreamChunk",
546 "to": "reference/interfaces/ContentStreamChunk"
547 },
548 {
549 "label": "DefaultMessageMetadataByModality",
550 "to": "reference/interfaces/DefaultMessageMetadataByModality"
551 },
552 {
553 "label": "DocumentPart",
554 "to": "reference/interfaces/DocumentPart"
555 },
556 {
557 "label": "DoneStreamChunk",
558 "to": "reference/interfaces/DoneStreamChunk"
559 },
560 {
561 "label": "EmbeddingOptions",
562 "to": "reference/interfaces/EmbeddingOptions"
563 },
564 {
565 "label": "EmbeddingResult",
566 "to": "reference/interfaces/EmbeddingResult"
567 },
568 {
569 "label": "ErrorStreamChunk",
570 "to": "reference/interfaces/ErrorStreamChunk"
571 },
572 {
573 "label": "ImagePart",
574 "to": "reference/interfaces/ImagePart"
575 },
576 {
577 "label": "InternalToolCallState",
578 "to": "reference/interfaces/InternalToolCallState"
579 },
580 {
581 "label": "JSONParser",
582 "to": "reference/interfaces/JSONParser"
583 },
584 {
585 "label": "ModelMessage",
586 "to": "reference/interfaces/ModelMessage"
587 },
588 {
589 "label": "ProcessorResult",
590 "to": "reference/interfaces/ProcessorResult"
591 },
592 {
593 "label": "ProcessorState",
594 "to": "reference/interfaces/ProcessorState"
595 },
596 {
597 "label": "RealtimeAdapter",
598 "to": "reference/interfaces/RealtimeAdapter"
599 },
600 {
601 "label": "RealtimeClientOptions",
602 "to": "reference/interfaces/RealtimeClientOptions"
603 },
604 {
605 "label": "RealtimeConnection",
606 "to": "reference/interfaces/RealtimeConnection"
607 },
608 {
609 "label": "RealtimeMessage",
610 "to": "reference/interfaces/RealtimeMessage"
611 },
612 {
613 "label": "RealtimeSessionConfig",
614 "to": "reference/interfaces/RealtimeSessionConfig"
615 },
616 {
617 "label": "RealtimeToken",
618 "to": "reference/interfaces/RealtimeToken"
619 },
620 {
621 "label": "RealtimeTokenAdapter",
622 "to": "reference/interfaces/RealtimeTokenAdapter"
623 },
624 {
625 "label": "RealtimeTokenOptions",
626 "to": "reference/interfaces/RealtimeTokenOptions"
627 },
628 {
629 "label": "ResponseFormat",
630 "to": "reference/interfaces/ResponseFormat"
631 },
632 {
633 "label": "ServerTool",
634 "to": "reference/interfaces/ServerTool"
635 },
636 {
637 "label": "StreamProcessorEvents",
638 "to": "reference/interfaces/StreamProcessorEvents"
639 },
640 {
641 "label": "StreamProcessorHandlers",
642 "to": "reference/interfaces/StreamProcessorHandlers"
643 },
644 {
645 "label": "StreamProcessorOptions",
646 "to": "reference/interfaces/StreamProcessorOptions"
647 },
648 {
649 "label": "SummarizationOptions",
650 "to": "reference/interfaces/SummarizationOptions"
651 },
652 {
653 "label": "SummarizationResult",
654 "to": "reference/interfaces/SummarizationResult"
655 },
656 {
657 "label": "TextPart",
658 "to": "reference/interfaces/TextPart"
659 },
660 {
661 "label": "ThinkingPart",
662 "to": "reference/interfaces/ThinkingPart"
663 },
664 {
665 "label": "ThinkingStreamChunk",
666 "to": "reference/interfaces/ThinkingStreamChunk"
667 },
668 {
669 "label": "Tool",
670 "to": "reference/interfaces/Tool"
671 },
672 {
673 "label": "ToolCall",
674 "to": "reference/interfaces/ToolCall"
675 },
676 {
677 "label": "ToolCallPart",
678 "to": "reference/interfaces/ToolCallPart"
679 },
680 {
681 "label": "ToolCallStreamChunk",
682 "to": "reference/interfaces/ToolCallStreamChunk"
683 },
684 {
685 "label": "ToolConfig",
686 "to": "reference/interfaces/ToolConfig"
687 },
688 {
689 "label": "ToolDefinition",
690 "to": "reference/interfaces/ToolDefinition"
691 },
692 {
693 "label": "ToolDefinitionConfig",
694 "to": "reference/interfaces/ToolDefinitionConfig"
695 },
696 {
697 "label": "ToolDefinitionInstance",
698 "to": "reference/interfaces/ToolDefinitionInstance"
699 },
700 {
701 "label": "ToolInputAvailableStreamChunk",
702 "to": "reference/interfaces/ToolInputAvailableStreamChunk"
703 },
704 {
705 "label": "ToolResultPart",
706 "to": "reference/interfaces/ToolResultPart"
707 },
708 {
709 "label": "ToolResultStreamChunk",
710 "to": "reference/interfaces/ToolResultStreamChunk"
711 },
712 {
713 "label": "UIMessage",
714 "to": "reference/interfaces/UIMessage"
715 },
716 {
717 "label": "VideoPart",
718 "to": "reference/interfaces/VideoPart"
719 }
720 ]
721 },
722 {
723 "label": "Type Alias References",
724 "collapsible": true,
725 "defaultCollapsed": true,
726 "children": [
727 {
728 "label": "AgentLoopStrategy",
729 "to": "reference/type-aliases/AgentLoopStrategy"
730 },
731 {
732 "label": "AnyClientTool",
733 "to": "reference/type-aliases/AnyClientTool"
734 },
735 {
736 "label": "TextStreamOptionsForModel",
737 "to": "reference/type-aliases/TextStreamOptionsForModel"
738 },
739 {
740 "label": "TextStreamOptionsUnion",
741 "to": "reference/type-aliases/TextStreamOptionsUnion"
742 },
743 {
744 "label": "ConstrainedContent",
745 "to": "reference/type-aliases/ConstrainedContent"
746 },
747 {
748 "label": "ConstrainedModelMessage",
749 "to": "reference/type-aliases/ConstrainedModelMessage"
750 },
751 {
752 "label": "ContentPart",
753 "to": "reference/type-aliases/ContentPart"
754 },
755 {
756 "label": "ContentPartForModalities",
757 "to": "reference/type-aliases/ContentPartForModalities"
758 },
759 {
760 "label": "ExtractModalitiesForModel",
761 "to": "reference/type-aliases/ExtractModalitiesForModel"
762 },
763 {
764 "label": "ExtractModelsFromAdapter",
765 "to": "reference/type-aliases/ExtractModelsFromAdapter"
766 },
767 {
768 "label": "InferToolInput",
769 "to": "reference/type-aliases/InferToolInput"
770 },
771 {
772 "label": "InferToolName",
773 "to": "reference/type-aliases/InferToolName"
774 },
775 {
776 "label": "InferToolOutput",
777 "to": "reference/type-aliases/InferToolOutput"
778 },
779 {
780 "label": "MessagePart",
781 "to": "reference/type-aliases/MessagePart"
782 },
783 {
784 "label": "RealtimeEvent",
785 "to": "reference/type-aliases/RealtimeEvent"
786 },
787 {
788 "label": "RealtimeMessagePart",
789 "to": "reference/type-aliases/RealtimeMessagePart"
790 },
791 {
792 "label": "RealtimeMode",
793 "to": "reference/type-aliases/RealtimeMode"
794 },
795 {
796 "label": "RealtimeStatus",
797 "to": "reference/type-aliases/RealtimeStatus"
798 },
799 {
800 "label": "ModalitiesArrayToUnion",
801 "to": "reference/type-aliases/ModalitiesArrayToUnion"
802 },
803 {
804 "label": "Modality",
805 "to": "reference/type-aliases/Modality"
806 },
807 {
808 "label": "StreamChunk",
809 "to": "reference/type-aliases/StreamChunk"
810 },
811 {
812 "label": "StreamChunkType",
813 "to": "reference/type-aliases/StreamChunkType"
814 },
815 {
816 "label": "ToolCallState",
817 "to": "reference/type-aliases/ToolCallState"
818 },
819 {
820 "label": "ToolResultState",
821 "to": "reference/type-aliases/ToolResultState"
822 }
823 ]
824 },
825 {
826 "label": "Variable References",
827 "collapsible": true,
828 "defaultCollapsed": true,
829 "children": [
830 {
831 "label": "aiEventClient",
832 "to": "reference/variables/aiEventClient"
833 },
834 {
835 "label": "defaultJSONParser",
836 "to": "reference/variables/defaultJSONParser"
837 }
838 ]
839 }
840 ]