# @tanstack/ai # @tanstack/ai ## Classes - [BatchStrategy](classes/BatchStrategy.md) - [CompositeStrategy](classes/CompositeStrategy.md) - [ConsoleLogger](classes/ConsoleLogger.md) - [ImmediateStrategy](classes/ImmediateStrategy.md) - [MCPDuplicateToolNameError](classes/MCPDuplicateToolNameError.md) - [PartialJSONParser](classes/PartialJSONParser.md) - [PunctuationStrategy](classes/PunctuationStrategy.md) - [StandardSchemaValidationError](classes/StandardSchemaValidationError.md) - [StreamProcessor](classes/StreamProcessor.md) - [ToolCallManager](classes/ToolCallManager.md) - [WordBoundaryStrategy](classes/WordBoundaryStrategy.md) ## Interfaces - [AbortInfo](interfaces/AbortInfo.md) - [AfterToolCallInfo](interfaces/AfterToolCallInfo.md) - [AgentLoopState](interfaces/AgentLoopState.md) - [ApprovalRequestedEvent](interfaces/ApprovalRequestedEvent.md) - [AudioAdapter](interfaces/AudioAdapter.md) - [AudioGenerationOptions](interfaces/AudioGenerationOptions.md) - [AudioGenerationResult](interfaces/AudioGenerationResult.md) - [AudioPart](interfaces/AudioPart.md) - [AudioVisualization](interfaces/AudioVisualization.md) - [BaseAGUIEvent](interfaces/BaseAGUIEvent.md) - [BaseUsageInput](interfaces/BaseUsageInput.md) - [CapabilityContext](interfaces/CapabilityContext.md) - [CapabilityGetter](interfaces/CapabilityGetter.md) - [ChatMCPOptions](interfaces/ChatMCPOptions.md) - [ChatMiddleware](interfaces/ChatMiddleware.md) - [ChatMiddlewareConfig](interfaces/ChatMiddlewareConfig.md) - [ChatMiddlewareContext](interfaces/ChatMiddlewareContext.md) - [ChatSandboxHooks](interfaces/ChatSandboxHooks.md) - [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) - [DebugCategories](interfaces/DebugCategories.md) - [DebugConfig](interfaces/DebugConfig.md) - [DefaultMessageMetadataByModality](interfaces/DefaultMessageMetadataByModality.md) - [DefinedChatMiddleware](interfaces/DefinedChatMiddleware.md) - [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) - [GenerationFinishInfo](interfaces/GenerationFinishInfo.md) - [GenerationMiddleware](interfaces/GenerationMiddleware.md) - [GenerationMiddlewareContext](interfaces/GenerationMiddlewareContext.md) - [GenerationUsageInfo](interfaces/GenerationUsageInfo.md) - [ImageAdapter](interfaces/ImageAdapter.md) - [ImageGenerationOptions](interfaces/ImageGenerationOptions.md) - [ImageGenerationResult](interfaces/ImageGenerationResult.md) - [ImagePart](interfaces/ImagePart.md) - [InternalToolCallState](interfaces/InternalToolCallState.md) - [IterationInfo](interfaces/IterationInfo.md) - [JSONParser](interfaces/JSONParser.md) - [JSONSchema](interfaces/JSONSchema.md) - [LazyToolsConfig](interfaces/LazyToolsConfig.md) - [Logger](interfaces/Logger.md) - [MCPToolSource](interfaces/MCPToolSource.md) - [MediaInputMetadata](interfaces/MediaInputMetadata.md) - [MessagesSnapshotEvent](interfaces/MessagesSnapshotEvent.md) - [ModelCapabilities](interfaces/ModelCapabilities.md) - [ModelMessage](interfaces/ModelMessage.md) - [NormalizedSystemPrompt](interfaces/NormalizedSystemPrompt.md) - [ProcessorResult](interfaces/ProcessorResult.md) - [ProcessorState](interfaces/ProcessorState.md) - [ProviderExecutedToolMetadata](interfaces/ProviderExecutedToolMetadata.md) - [ProviderTool](interfaces/ProviderTool.md) - [RealtimeAdapter](interfaces/RealtimeAdapter.md) - [RealtimeAudioPart](interfaces/RealtimeAudioPart.md) - [RealtimeConnection](interfaces/RealtimeConnection.md) - [RealtimeError](interfaces/RealtimeError.md) - [RealtimeEventPayloads](interfaces/RealtimeEventPayloads.md) - [RealtimeImagePart](interfaces/RealtimeImagePart.md) - [RealtimeMessage](interfaces/RealtimeMessage.md) - [RealtimeSessionConfig](interfaces/RealtimeSessionConfig.md) - [RealtimeTextPart](interfaces/RealtimeTextPart.md) - [RealtimeToken](interfaces/RealtimeToken.md) - [RealtimeTokenAdapter](interfaces/RealtimeTokenAdapter.md) - [RealtimeTokenOptions](interfaces/RealtimeTokenOptions.md) - [RealtimeToolCallPart](interfaces/RealtimeToolCallPart.md) - [RealtimeToolConfig](interfaces/RealtimeToolConfig.md) - [RealtimeToolResultPart](interfaces/RealtimeToolResultPart.md) - [ReasoningEncryptedValueEvent](interfaces/ReasoningEncryptedValueEvent.md) - [ReasoningEndEvent](interfaces/ReasoningEndEvent.md) - [ReasoningMessageContentEvent](interfaces/ReasoningMessageContentEvent.md) - [ReasoningMessageEndEvent](interfaces/ReasoningMessageEndEvent.md) - [ReasoningMessageStartEvent](interfaces/ReasoningMessageStartEvent.md) - [ReasoningStartEvent](interfaces/ReasoningStartEvent.md) - [ResolvedMediaPrompt](interfaces/ResolvedMediaPrompt.md) - [ResponseFormat](interfaces/ResponseFormat.md) - [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) - [StepStartedEvent](interfaces/StepStartedEvent.md) - [StreamProcessorEvents](interfaces/StreamProcessorEvents.md) - [StreamProcessorOptions](interfaces/StreamProcessorOptions.md) - [StructuredOutputCompleteEvent](interfaces/StructuredOutputCompleteEvent.md) - [StructuredOutputMiddlewareConfig](interfaces/StructuredOutputMiddlewareConfig.md) - [StructuredOutputPart](interfaces/StructuredOutputPart.md) - [StructuredOutputStartEvent](interfaces/StructuredOutputStartEvent.md) - [SummarizationOptions](interfaces/SummarizationOptions.md) - [SummarizationResult](interfaces/SummarizationResult.md) - [SummarizeAdapter](interfaces/SummarizeAdapter.md) - [TextAdapter](interfaces/TextAdapter.md) - [TextCompletionChunk](interfaces/TextCompletionChunk.md) - [TextMessageContentEvent](interfaces/TextMessageContentEvent.md) - [TextMessageEndEvent](interfaces/TextMessageEndEvent.md) - [TextMessageStartEvent](interfaces/TextMessageStartEvent.md) - [TextOptions](interfaces/TextOptions.md) - [TextPart](interfaces/TextPart.md) - [ThinkingPart](interfaces/ThinkingPart.md) - [Tool](interfaces/Tool.md) - [ToolCall](interfaces/ToolCall.md) - [ToolCallArgsEvent](interfaces/ToolCallArgsEvent.md) - [ToolCallEndEvent](interfaces/ToolCallEndEvent.md) - [ToolCallHookContext](interfaces/ToolCallHookContext.md) - [ToolCallPart](interfaces/ToolCallPart.md) - [ToolCallResultEvent](interfaces/ToolCallResultEvent.md) - [ToolCallStartEvent](interfaces/ToolCallStartEvent.md) - [ToolConfig](interfaces/ToolConfig.md) - [ToolDefinition](interfaces/ToolDefinition.md) - [ToolDefinitionConfig](interfaces/ToolDefinitionConfig.md) - [ToolDefinitionInstance](interfaces/ToolDefinitionInstance.md) - [ToolInputAvailableEvent](interfaces/ToolInputAvailableEvent.md) - [ToolPhaseCompleteInfo](interfaces/ToolPhaseCompleteInfo.md) - [ToolRegistry](interfaces/ToolRegistry.md) - [ToolResultPart](interfaces/ToolResultPart.md) - [TranscriptionAdapter](interfaces/TranscriptionAdapter.md) - [TranscriptionOptions](interfaces/TranscriptionOptions.md) - [TranscriptionResult](interfaces/TranscriptionResult.md) - [TranscriptionSegment](interfaces/TranscriptionSegment.md) - [TranscriptionWord](interfaces/TranscriptionWord.md) - [TTSAdapter](interfaces/TTSAdapter.md) - [TTSOptions](interfaces/TTSOptions.md) - [TTSResult](interfaces/TTSResult.md) - [UIMessage](interfaces/UIMessage.md) - [UIResourceEvent](interfaces/UIResourceEvent.md) - [UIResourcePart](interfaces/UIResourcePart.md) - [UsageInfo](interfaces/UsageInfo.md) - [VADConfig](interfaces/VADConfig.md) - [VideoAdapter](interfaces/VideoAdapter.md) - [VideoGenerationOptions](interfaces/VideoGenerationOptions.md) - [VideoJobResult](interfaces/VideoJobResult.md) - [VideoPart](interfaces/VideoPart.md) - [VideoStatusResult](interfaces/VideoStatusResult.md) - [VideoUrlResult](interfaces/VideoUrlResult.md) ## Type Aliases - [AgentLoopStrategy](type-aliases/AgentLoopStrategy.md) - [AGUIEvent](type-aliases/AGUIEvent.md) - [~~AGUIEventType~~](type-aliases/AGUIEventType.md) - [AIAdapter](type-aliases/AIAdapter.md) - [AnyAudioAdapter](type-aliases/AnyAudioAdapter.md) - [AnyChatMiddleware](type-aliases/AnyChatMiddleware.md) - [AnyClientTool](type-aliases/AnyClientTool.md) - [AnyGenerationMiddleware](type-aliases/AnyGenerationMiddleware.md) - [AnyImageAdapter](type-aliases/AnyImageAdapter.md) - [AnySummarizeAdapter](type-aliases/AnySummarizeAdapter.md) - [AnyTextAdapter](type-aliases/AnyTextAdapter.md) - [AnyTool](type-aliases/AnyTool.md) - [AnyTranscriptionAdapter](type-aliases/AnyTranscriptionAdapter.md) - [AnyTTSAdapter](type-aliases/AnyTTSAdapter.md) - [AnyVideoAdapter](type-aliases/AnyVideoAdapter.md) - [BeforeToolCallDecision](type-aliases/BeforeToolCallDecision.md) - [Capability](type-aliases/Capability.md) - [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) - [ContentPartForInputModalitiesTypes](type-aliases/ContentPartForInputModalitiesTypes.md) - [ContentPartSource](type-aliases/ContentPartSource.md) - [DebugOption](type-aliases/DebugOption.md) - [DeepPartial](type-aliases/DeepPartial.md) - [GeneratedAudio](type-aliases/GeneratedAudio.md) - [GeneratedImage](type-aliases/GeneratedImage.md) - [GeneratedMediaSource](type-aliases/GeneratedMediaSource.md) - [GenerationActivity](type-aliases/GenerationActivity.md) - [InferSchemaType](type-aliases/InferSchemaType.md) - [InferToolInput](type-aliases/InferToolInput.md) - [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) - [MediaPromptFor](type-aliases/MediaPromptFor.md) - [MediaPromptModality](type-aliases/MediaPromptModality.md) - [MediaPromptPart](type-aliases/MediaPromptPart.md) - [MessagePart](type-aliases/MessagePart.md) - [ModalitiesArrayToUnion](type-aliases/ModalitiesArrayToUnion.md) - [Modality](type-aliases/Modality.md) - [ModelInputModalitiesByName](type-aliases/ModelInputModalitiesByName.md) - [RealtimeErrorCode](type-aliases/RealtimeErrorCode.md) - [RealtimeEvent](type-aliases/RealtimeEvent.md) - [RealtimeEventHandler](type-aliases/RealtimeEventHandler.md) - [RealtimeMessagePart](type-aliases/RealtimeMessagePart.md) - [RealtimeMode](type-aliases/RealtimeMode.md) - [RealtimeStatus](type-aliases/RealtimeStatus.md) - [SchemaInput](type-aliases/SchemaInput.md) - [StreamChunk](type-aliases/StreamChunk.md) - [~~StreamChunkType~~](type-aliases/StreamChunkType.md) - [StructuredOutputStream](type-aliases/StructuredOutputStream.md) - [SystemPrompt](type-aliases/SystemPrompt.md) - [ToolCallState](type-aliases/ToolCallState.md) - [ToolExecuteFunction](type-aliases/ToolExecuteFunction.md) - [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) ## Variables - [defaultJSONParser](variables/defaultJSONParser.md) - [DISCOVERY\_TOOL\_NAME](variables/DISCOVERY_TOOL_NAME.md) ## Functions - [brandProviderTool](functions/brandProviderTool.md) - [buildBaseUsage](functions/buildBaseUsage.md) - [chat](functions/chat.md) - [chatParamsFromRequest](functions/chatParamsFromRequest.md) - [chatParamsFromRequestBody](functions/chatParamsFromRequestBody.md) - [combineStrategies](functions/combineStrategies.md) - [convertMessagesToModelMessages](functions/convertMessagesToModelMessages.md) - [convertSchemaToJsonSchema](functions/convertSchemaToJsonSchema.md) - [createAudioOptions](functions/createAudioOptions.md) - [createCapability](functions/createCapability.md) - [createChatMiddleware](functions/createChatMiddleware.md) - [createChatOptions](functions/createChatOptions.md) - [createFrozenRegistry](functions/createFrozenRegistry.md) - [createImageOptions](functions/createImageOptions.md) - [createModel](functions/createModel.md) - [createRealtimeEventEmitter](functions/createRealtimeEventEmitter.md) - [createReplayStream](functions/createReplayStream.md) - [createSpeechOptions](functions/createSpeechOptions.md) - [createSummarizeOptions](functions/createSummarizeOptions.md) - [createToolRegistry](functions/createToolRegistry.md) - [createTranscriptionOptions](functions/createTranscriptionOptions.md) - [createVideoOptions](functions/createVideoOptions.md) - [defineChatMiddleware](functions/defineChatMiddleware.md) - [detectImageMimeType](functions/detectImageMimeType.md) - [extendAdapter](functions/extendAdapter.md) - [firstSentence](functions/firstSentence.md) - [generateAudio](functions/generateAudio.md) - [generateImage](functions/generateImage.md) - [generateMessageId](functions/generateMessageId.md) - [generateSpeech](functions/generateSpeech.md) - [generateTranscription](functions/generateTranscription.md) - [generateVideo](functions/generateVideo.md) - [getProviderExecutedMetadata](functions/getProviderExecutedMetadata.md) - [getVideoJobStatus](functions/getVideoJobStatus.md) - [isContentPart](functions/isContentPart.md) - [isContentPartArray](functions/isContentPartArray.md) - [isProviderExecutedToolCall](functions/isProviderExecutedToolCall.md) - [isStandardSchema](functions/isStandardSchema.md) - [maxIterations](functions/maxIterations.md) - [mergeAgentTools](functions/mergeAgentTools.md) - [modelMessagesToUIMessages](functions/modelMessagesToUIMessages.md) - [modelMessageToUIMessage](functions/modelMessageToUIMessage.md) - [normalizeSystemPrompts](functions/normalizeSystemPrompts.md) - [normalizeToolResult](functions/normalizeToolResult.md) - [normalizeToUIMessage](functions/normalizeToUIMessage.md) - [parsePartialJSON](functions/parsePartialJSON.md) - [parseWithStandardSchema](functions/parseWithStandardSchema.md) - [realtimeToken](functions/realtimeToken.md) - [renderLazyCatalogEntry](functions/renderLazyCatalogEntry.md) - [resolveMediaPrompt](functions/resolveMediaPrompt.md) - [streamToText](functions/streamToText.md) - [summarize](functions/summarize.md) - [toHttpResponse](functions/toHttpResponse.md) - [toHttpStream](functions/toHttpStream.md) - [toolDefinition](functions/toolDefinition.md) - [toServerSentEventsResponse](functions/toServerSentEventsResponse.md) - [toServerSentEventsStream](functions/toServerSentEventsStream.md) - [uiMessagesToWire](functions/uiMessagesToWire.md) - [uiMessageToModelMessages](functions/uiMessageToModelMessages.md) - [untilFinishReason](functions/untilFinishReason.md)