config.json

{
  "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
  "docSearch": {
    "appId": "FQ0DQ6MA3C",
    "apiKey": "8264730bab8a9b7fa6a0c85761d7a3fe",
    "indexName": "tanstack"
  },
  "sections": [
    {
      "label": "Getting Started",
      "children": [
        {
          "label": "Overview",
          "to": "getting-started/overview"
        },
        {
          "label": "Quick Start: React",
          "to": "getting-started/quick-start"
        },
        {
          "label": "Devtools",
          "to": "getting-started/devtools"
        },
        {
          "label": "Quick Start: Vue",
          "to": "getting-started/quick-start-vue"
        },
        {
          "label": "Quick Start: Svelte",
          "to": "getting-started/quick-start-svelte"
        },
        {
          "label": "Quick Start: Server Only",
          "to": "getting-started/quick-start-server"
        },
        {
          "label": "Agent Skills (TanStack Intent)",
          "to": "getting-started/agent-skills"
        }
      ]
    },
    {
      "label": "Comparison",
      "children": [
        {
          "label": "TanStack AI vs Vercel AI SDK",
          "to": "comparison/vercel-ai-sdk"
        }
      ]
    },
    {
      "label": "Tools",
      "children": [
        {
          "label": "Tools",
          "to": "tools/tools"
        },
        {
          "label": "Provider Tools",
          "to": "tools/provider-tools"
        },
        {
          "label": "Tool Architecture",
          "to": "tools/tool-architecture"
        },
        {
          "label": "Server Tools",
          "to": "tools/server-tools"
        },
        {
          "label": "Client Tools",
          "to": "tools/client-tools"
        },
        {
          "label": "Tool Approval Flow",
          "to": "tools/tool-approval"
        },
        {
          "label": "Lazy Tool Discovery",
          "to": "tools/lazy-tool-discovery"
        }
      ]
    },
    {
      "label": "Chat & Streaming",
      "children": [
        {
          "label": "Agentic Cycle",
          "to": "chat/agentic-cycle"
        },
        {
          "label": "Streaming",
          "to": "chat/streaming"
        },
        {
          "label": "Connection Adapters",
          "to": "chat/connection-adapters"
        },
        {
          "label": "Thinking & Reasoning",
          "to": "chat/thinking-content"
        }
      ]
    },
    {
      "label": "Structured Outputs",
      "children": [
        {
          "label": "Overview",
          "to": "structured-outputs/overview"
        },
        {
          "label": "One-Shot Extraction",
          "to": "structured-outputs/one-shot"
        },
        {
          "label": "Streaming UIs",
          "to": "structured-outputs/streaming"
        },
        {
          "label": "Multi-Turn Chat",
          "to": "structured-outputs/multi-turn"
        },
        {
          "label": "With Tools",
          "to": "structured-outputs/with-tools"
        }
      ]
    },
    {
      "label": "Code Mode",
      "children": [
        {
          "label": "Code Mode",
          "to": "code-mode/code-mode"
        },
        {
          "label": "Showing Code Mode in the UI",
          "to": "code-mode/client-integration"
        },
        {
          "label": "Code Mode with Skills",
          "to": "code-mode/code-mode-with-skills"
        },
        {
          "label": "Code Mode Isolate Drivers",
          "to": "code-mode/code-mode-isolates"
        }
      ]
    },
    {
      "label": "Media",
      "children": [
        {
          "label": "Generations",
          "to": "media/generations"
        },
        {
          "label": "Realtime Voice Chat",
          "to": "media/realtime-chat"
        },
        {
          "label": "Text-to-Speech",
          "to": "media/text-to-speech"
        },
        {
          "label": "Transcription",
          "to": "media/transcription"
        },
        {
          "label": "Audio Generation",
          "to": "media/audio-generation"
        },
        {
          "label": "Image Generation",
          "to": "media/image-generation"
        },
        {
          "label": "Video Generation",
          "to": "media/video-generation"
        },
        {
          "label": "Generation Hooks",
          "to": "media/generation-hooks"
        }
      ]
    },
    {
      "label": "Advanced",
      "children": [
        {
          "label": "Middleware",
          "to": "advanced/middleware"
        },
        {
          "label": "Debug Logging",
          "to": "advanced/debug-logging"
        },
        {
          "label": "OpenTelemetry",
          "to": "advanced/otel"
        },
        {
          "label": "Observability",
          "to": "advanced/observability"
        },
        {
          "label": "Multimodal Content",
          "to": "advanced/multimodal-content"
        },
        {
          "label": "Per-Model Type Safety",
          "to": "advanced/per-model-type-safety"
        },
        {
          "label": "Runtime Adapter Switching",
          "to": "advanced/runtime-adapter-switching"
        },
        {
          "label": "Tree-Shaking",
          "to": "advanced/tree-shaking"
        },
        {
          "label": "Extend Adapter",
          "to": "advanced/extend-adapter"
        }
      ]
    },
    {
      "label": "Migration",
      "children": [
        {
          "label": "Migration Guide",
          "to": "migration/migration"
        },
        {
          "label": "From Vercel AI SDK",
          "to": "migration/migration-from-vercel-ai"
        },
        {
          "label": "AG-UI Client Compliance",
          "to": "migration/ag-ui-compliance"
        }
      ]
    },
    {
      "label": "API",
      "children": [
        {
          "label": "@tanstack/ai",
          "to": "api/ai"
        },
        {
          "label": "@tanstack/ai-client",
          "to": "api/ai-client"
        },
        {
          "label": "@tanstack/ai-react",
          "to": "api/ai-react"
        },
        {
          "label": "@tanstack/ai-solid",
          "to": "api/ai-solid"
        },
        {
          "label": "@tanstack/ai-preact",
          "to": "api/ai-preact"
        },
        {
          "label": "@tanstack/ai-vue",
          "to": "api/ai-vue"
        },
        {
          "label": "@tanstack/ai-svelte",
          "to": "api/ai-svelte"
        }
      ]
    },
    {
      "label": "Adapters",
      "children": [
        {
          "label": "OpenAI",
          "to": "adapters/openai"
        },
        {
          "label": "Anthropic",
          "to": "adapters/anthropic"
        },
        {
          "label": "Google Gemini",
          "to": "adapters/gemini"
        },
        {
          "label": "Ollama",
          "to": "adapters/ollama"
        },
        {
          "label": "Grok (xAI)",
          "to": "adapters/grok"
        },
        {
          "label": "Groq",
          "to": "adapters/groq"
        },
        {
          "label": "ElevenLabs",
          "to": "adapters/elevenlabs"
        },
        {
          "label": "fal.ai",
          "to": "adapters/fal"
        },
        {
          "label": "OpenRouter Adapter",
          "to": "adapters/openrouter"
        },
        {
          "label": "Perplexity",
          "to": "adapters/perplexity"
        }
      ]
    },
    {
      "label": "Community Adapters",
      "children": [
        {
          "label": "Community Adapters Guide",
          "to": "community-adapters/guide"
        },
        {
          "label": "Decart",
          "to": "community-adapters/decart"
        },
        {
          "label": "Cencori",
          "to": "community-adapters/cencori"
        },
        {
          "label": "Cloudflare",
          "to": "community-adapters/cloudflare"
        },
        {
          "label": "Soniox",
          "to": "community-adapters/soniox"
        },
        {
          "label": "Mynth",
          "to": "community-adapters/mynth"
        }
      ]
    },
    {
      "label": "Class References",
      "collapsible": true,
      "defaultCollapsed": true,
      "children": [
        {
          "label": "BaseAdapter",
          "to": "reference/classes/BaseAdapter"
        },
        {
          "label": "BatchStrategy",
          "to": "reference/classes/BatchStrategy"
        },
        {
          "label": "CompositeStrategy",
          "to": "reference/classes/CompositeStrategy"
        },
        {
          "label": "ImmediateStrategy",
          "to": "reference/classes/ImmediateStrategy"
        },
        {
          "label": "PartialJSONParser",
          "to": "reference/classes/PartialJSONParser"
        },
        {
          "label": "PunctuationStrategy",
          "to": "reference/classes/PunctuationStrategy"
        },
        {
          "label": "StreamProcessor",
          "to": "reference/classes/StreamProcessor"
        },
        {
          "label": "ToolCallManager",
          "to": "reference/classes/ToolCallManager"
        },
        {
          "label": "RealtimeClient",
          "to": "reference/classes/RealtimeClient"
        },
        {
          "label": "WordBoundaryStrategy",
          "to": "reference/classes/WordBoundaryStrategy"
        }
      ]
    },
    {
      "label": "Function References",
      "collapsible": true,
      "defaultCollapsed": true,
      "children": [
        {
          "label": "text",
          "to": "reference/functions/text"
        },
        {
          "label": "textOptions",
          "to": "reference/functions/textOptions"
        },
        {
          "label": "combineStrategies",
          "to": "reference/functions/combineStrategies"
        },
        {
          "label": "convertMessagesToModelMessages",
          "to": "reference/functions/convertMessagesToModelMessages"
        },
        {
          "label": "convertZodToJsonSchema",
          "to": "reference/functions/convertZodToJsonSchema"
        },
        {
          "label": "createReplayStream",
          "to": "reference/functions/createReplayStream"
        },
        {
          "label": "embedding",
          "to": "reference/functions/embedding"
        },
        {
          "label": "generateMessageId",
          "to": "reference/functions/generateMessageId"
        },
        {
          "label": "maxIterations",
          "to": "reference/functions/maxIterations"
        },
        {
          "label": "messages",
          "to": "reference/functions/messages"
        },
        {
          "label": "modelMessageToUIMessage",
          "to": "reference/functions/modelMessageToUIMessage"
        },
        {
          "label": "modelMessagesToUIMessages",
          "to": "reference/functions/modelMessagesToUIMessages"
        },
        {
          "label": "normalizeToUIMessage",
          "to": "reference/functions/normalizeToUIMessage"
        },
        {
          "label": "parsePartialJSON",
          "to": "reference/functions/parsePartialJSON"
        },
        {
          "label": "summarize",
          "to": "reference/functions/summarize"
        },
        {
          "label": "toServerSentEventsStream",
          "to": "reference/functions/toServerSentEventsStream"
        },
        {
          "label": "toServerSentEventsResponse",
          "to": "reference/functions/toServerSentEventsResponse"
        },
        {
          "label": "toolDefinition",
          "to": "reference/functions/toolDefinition"
        },
        {
          "label": "uiMessageToModelMessages",
          "to": "reference/functions/uiMessageToModelMessages"
        },
        {
          "label": "realtimeToken",
          "to": "reference/functions/realtimeToken"
        },
        {
          "label": "untilFinishReason",
          "to": "reference/functions/untilFinishReason"
        }
      ]
    },
    {
      "label": "Interface References",
      "collapsible": true,
      "defaultCollapsed": true,
      "children": [
        {
          "label": "AIAdapter",
          "to": "reference/interfaces/AIAdapter"
        },
        {
          "label": "AIAdapterConfig",
          "to": "reference/interfaces/AIAdapterConfig"
        },
        {
          "label": "AgentLoopState",
          "to": "reference/interfaces/AgentLoopState"
        },
        {
          "label": "ApprovalRequestedStreamChunk",
          "to": "reference/interfaces/ApprovalRequestedStreamChunk"
        },
        {
          "label": "AudioPart",
          "to": "reference/interfaces/AudioPart"
        },
        {
          "label": "AudioVisualization",
          "to": "reference/interfaces/AudioVisualization"
        },
        {
          "label": "BaseStreamChunk",
          "to": "reference/interfaces/BaseStreamChunk"
        },
        {
          "label": "TextCompletionChunk",
          "to": "reference/interfaces/TextCompletionChunk"
        },
        {
          "label": "TextOptions",
          "to": "reference/interfaces/TextOptions"
        },
        {
          "label": "ChunkRecording",
          "to": "reference/interfaces/ChunkRecording"
        },
        {
          "label": "ChunkStrategy",
          "to": "reference/interfaces/ChunkStrategy"
        },
        {
          "label": "ClientTool",
          "to": "reference/interfaces/ClientTool"
        },
        {
          "label": "ContentPartSource",
          "to": "reference/interfaces/ContentPartSource"
        },
        {
          "label": "ContentStreamChunk",
          "to": "reference/interfaces/ContentStreamChunk"
        },
        {
          "label": "DefaultMessageMetadataByModality",
          "to": "reference/interfaces/DefaultMessageMetadataByModality"
        },
        {
          "label": "DocumentPart",
          "to": "reference/interfaces/DocumentPart"
        },
        {
          "label": "DoneStreamChunk",
          "to": "reference/interfaces/DoneStreamChunk"
        },
        {
          "label": "EmbeddingOptions",
          "to": "reference/interfaces/EmbeddingOptions"
        },
        {
          "label": "EmbeddingResult",
          "to": "reference/interfaces/EmbeddingResult"
        },
        {
          "label": "ErrorStreamChunk",
          "to": "reference/interfaces/ErrorStreamChunk"
        },
        {
          "label": "ImagePart",
          "to": "reference/interfaces/ImagePart"
        },
        {
          "label": "InternalToolCallState",
          "to": "reference/interfaces/InternalToolCallState"
        },
        {
          "label": "JSONParser",
          "to": "reference/interfaces/JSONParser"
        },
        {
          "label": "ModelMessage",
          "to": "reference/interfaces/ModelMessage"
        },
        {
          "label": "ProcessorResult",
          "to": "reference/interfaces/ProcessorResult"
        },
        {
          "label": "ProcessorState",
          "to": "reference/interfaces/ProcessorState"
        },
        {
          "label": "RealtimeAdapter",
          "to": "reference/interfaces/RealtimeAdapter"
        },
        {
          "label": "RealtimeClientOptions",
          "to": "reference/interfaces/RealtimeClientOptions"
        },
        {
          "label": "RealtimeConnection",
          "to": "reference/interfaces/RealtimeConnection"
        },
        {
          "label": "RealtimeMessage",
          "to": "reference/interfaces/RealtimeMessage"
        },
        {
          "label": "RealtimeSessionConfig",
          "to": "reference/interfaces/RealtimeSessionConfig"
        },
        {
          "label": "RealtimeToken",
          "to": "reference/interfaces/RealtimeToken"
        },
        {
          "label": "RealtimeTokenAdapter",
          "to": "reference/interfaces/RealtimeTokenAdapter"
        },
        {
          "label": "RealtimeTokenOptions",
          "to": "reference/interfaces/RealtimeTokenOptions"
        },
        {
          "label": "ResponseFormat",
          "to": "reference/interfaces/ResponseFormat"
        },
        {
          "label": "ServerTool",
          "to": "reference/interfaces/ServerTool"
        },
        {
          "label": "StreamProcessorEvents",
          "to": "reference/interfaces/StreamProcessorEvents"
        },
        {
          "label": "StreamProcessorHandlers",
          "to": "reference/interfaces/StreamProcessorHandlers"
        },
        {
          "label": "StreamProcessorOptions",
          "to": "reference/interfaces/StreamProcessorOptions"
        },
        {
          "label": "SummarizationOptions",
          "to": "reference/interfaces/SummarizationOptions"
        },
        {
          "label": "SummarizationResult",
          "to": "reference/interfaces/SummarizationResult"
        },
        {
          "label": "TextPart",
          "to": "reference/interfaces/TextPart"
        },
        {
          "label": "ThinkingPart",
          "to": "reference/interfaces/ThinkingPart"
        },
        {
          "label": "ThinkingStreamChunk",
          "to": "reference/interfaces/ThinkingStreamChunk"
        },
        {
          "label": "Tool",
          "to": "reference/interfaces/Tool"
        },
        {
          "label": "ToolCall",
          "to": "reference/interfaces/ToolCall"
        },
        {
          "label": "ToolCallPart",
          "to": "reference/interfaces/ToolCallPart"
        },
        {
          "label": "ToolCallStreamChunk",
          "to": "reference/interfaces/ToolCallStreamChunk"
        },
        {
          "label": "ToolConfig",
          "to": "reference/interfaces/ToolConfig"
        },
        {
          "label": "ToolDefinition",
          "to": "reference/interfaces/ToolDefinition"
        },
        {
          "label": "ToolDefinitionConfig",
          "to": "reference/interfaces/ToolDefinitionConfig"
        },
        {
          "label": "ToolDefinitionInstance",
          "to": "reference/interfaces/ToolDefinitionInstance"
        },
        {
          "label": "ToolInputAvailableStreamChunk",
          "to": "reference/interfaces/ToolInputAvailableStreamChunk"
        },
        {
          "label": "ToolResultPart",
          "to": "reference/interfaces/ToolResultPart"
        },
        {
          "label": "ToolResultStreamChunk",
          "to": "reference/interfaces/ToolResultStreamChunk"
        },
        {
          "label": "UIMessage",
          "to": "reference/interfaces/UIMessage"
        },
        {
          "label": "VideoPart",
          "to": "reference/interfaces/VideoPart"
        }
      ]
    },
    {
      "label": "Type Alias References",
      "collapsible": true,
      "defaultCollapsed": true,
      "children": [
        {
          "label": "AgentLoopStrategy",
          "to": "reference/type-aliases/AgentLoopStrategy"
        },
        {
          "label": "AnyClientTool",
          "to": "reference/type-aliases/AnyClientTool"
        },
        {
          "label": "TextStreamOptionsForModel",
          "to": "reference/type-aliases/TextStreamOptionsForModel"
        },
        {
          "label": "TextStreamOptionsUnion",
          "to": "reference/type-aliases/TextStreamOptionsUnion"
        },
        {
          "label": "ConstrainedContent",
          "to": "reference/type-aliases/ConstrainedContent"
        },
        {
          "label": "ConstrainedModelMessage",
          "to": "reference/type-aliases/ConstrainedModelMessage"
        },
        {
          "label": "ContentPart",
          "to": "reference/type-aliases/ContentPart"
        },
        {
          "label": "ContentPartForModalities",
          "to": "reference/type-aliases/ContentPartForModalities"
        },
        {
          "label": "ExtractModalitiesForModel",
          "to": "reference/type-aliases/ExtractModalitiesForModel"
        },
        {
          "label": "ExtractModelsFromAdapter",
          "to": "reference/type-aliases/ExtractModelsFromAdapter"
        },
        {
          "label": "InferToolInput",
          "to": "reference/type-aliases/InferToolInput"
        },
        {
          "label": "InferToolName",
          "to": "reference/type-aliases/InferToolName"
        },
        {
          "label": "InferToolOutput",
          "to": "reference/type-aliases/InferToolOutput"
        },
        {
          "label": "MessagePart",
          "to": "reference/type-aliases/MessagePart"
        },
        {
          "label": "RealtimeEvent",
          "to": "reference/type-aliases/RealtimeEvent"
        },
        {
          "label": "RealtimeMessagePart",
          "to": "reference/type-aliases/RealtimeMessagePart"
        },
        {
          "label": "RealtimeMode",
          "to": "reference/type-aliases/RealtimeMode"
        },
        {
          "label": "RealtimeStatus",
          "to": "reference/type-aliases/RealtimeStatus"
        },
        {
          "label": "ModalitiesArrayToUnion",
          "to": "reference/type-aliases/ModalitiesArrayToUnion"
        },
        {
          "label": "Modality",
          "to": "reference/type-aliases/Modality"
        },
        {
          "label": "StreamChunk",
          "to": "reference/type-aliases/StreamChunk"
        },
        {
          "label": "StreamChunkType",
          "to": "reference/type-aliases/StreamChunkType"
        },
        {
          "label": "ToolCallState",
          "to": "reference/type-aliases/ToolCallState"
        },
        {
          "label": "ToolResultState",
          "to": "reference/type-aliases/ToolResultState"
        }
      ]
    },
    {
      "label": "Variable References",
      "collapsible": true,
      "defaultCollapsed": true,
      "children": [
        {
          "label": "aiEventClient",
          "to": "reference/variables/aiEventClient"
        },
        {
          "label": "defaultJSONParser",
          "to": "reference/variables/defaultJSONParser"
        }
      ]
    }
  ]
}