@tanstack/ai#

Classes#

• BaseRerankAdapter
• BatchStrategy
• CompositeStrategy
• ConsoleLogger
• ImmediateStrategy
• InMemoryRunStore
• InterruptResumeValidationError
• MCPDuplicateToolNameError
• PartialJSONParser
• PunctuationStrategy
• StandardSchemaValidationError
• StreamProcessor
• ToolCallManager
• WordBoundaryStrategy

Interfaces#

• AbortInfo
• AfterToolCallInfo
• AgentLoopState
• ApprovalRequestedEvent
• ApprovalRequestedPayload
• ApprovalResolvedPayload
• ArtifactCreatedPayload
• AudioAdapter
• AudioGenerationOptions
• AudioGenerationResult
• AudioPart
• AudioVisualization
• BaseAGUIEvent
• BaseUsageInput
• BatchInterruptError
• CapabilityContext
• CapabilityGetter
• ChatMCPOptions
• ChatMiddleware
• ChatMiddlewareConfig
• ChatMiddlewareContext
• ChatResumeToolState
• ChatSandboxHooks
• ChunkRecording
• ChunkStrategy
• ClientTool
• CodeModeConsoleEvent
• CodeModeExecutionStartedEvent
• CodeModeExternalCallEvent
• CodeModeExternalErrorEvent
• CodeModeExternalResultEvent
• CodeModeSnippetCallEvent
• CodeModeSnippetErrorEvent
• CodeModeSnippetResultEvent
• ContentPartDataSource
• ContentPartUrlSource
• CustomEvent
• DebugCategories
• DebugConfig
• DefaultMessageMetadataByModality
• DefinedChatMiddleware
• DocumentPart
• Embedding
• EmbeddingAdapter
• EmbeddingOptions
• EmbeddingResult
• ErrorInfo
• ExtendedModelDef
• FileChangedEvent
• FileChangedPayload
• FinishInfo
• GenerationAbortInfo
• GenerationErrorInfo
• GenerationFinishInfo
• GenerationMiddleware
• GenerationMiddlewareContext
• GenerationResultTransformContext
• GenerationUsageInfo
• ImageAdapter
• ImageGenerationOptions
• ImageGenerationResult
• ImagePart
• InternalToolCallState
• InterruptCorrelation
• ItemInterruptError
• IterationInfo
• JSONParser
• JSONSchema
• LazyToolsConfig
• Logger
• MCPToolSource
• MediaInputMetadata
• MemoryStreamInit
• MemoryStreamOptions
• MessagesSnapshotEvent
• ModelCapabilities
• ModelMessage
• NormalizedApprovalSchema
• NormalizedSchemaInput
• NormalizedSystemPrompt
• PendingInterruptResumeRecord
• PersistedArtifactRef
• PortOpenedPayload
• ProcessorResult
• ProcessorState
• ProcessOutputPayload
• ProviderExecutedToolMetadata
• ProviderTool
• RealtimeAdapter
• RealtimeAudioPart
• RealtimeConnection
• RealtimeError
• RealtimeEventPayloads
• RealtimeImagePart
• RealtimeMessage
• RealtimeSessionConfig
• RealtimeTextPart
• RealtimeToken
• RealtimeTokenAdapter
• RealtimeTokenOptions
• RealtimeToolCallPart
• RealtimeToolConfig
• RealtimeToolResultPart
• ReasoningEncryptedValueEvent
• ReasoningEndEvent
• ReasoningMessageContentEvent
• ReasoningMessageEndEvent
• ReasoningMessageStartEvent
• ReasoningStartEvent
• RerankAdapter
• RerankAdapterResult
• RerankOptions
• RerankResult
• ResolvedEmbeddingItem
• ResolvedMediaPrompt
• ResponseFormat
• RunDriverOptions
• RunError
• RunErrorEvent
• RunFinishedEvent
• RunRecord
• RunStartedEvent
• RunStore
• SandboxFileCustomEvent
• SandboxFileDiffEvent
• SandboxFileEvent
• SandboxFileHookEvent
• SandboxLifecyclePayload
• Scope
• ServerTool
• SessionIdEvent
• SnippetRegisteredEvent
• StateDeltaEvent
• StateSnapshotEvent
• StepFinishedEvent
• StepStartedEvent
• StreamDurability
• StreamProcessorEvents
• StreamProcessorOptions
• StructuredOutputCompleteEvent
• StructuredOutputMiddlewareConfig
• StructuredOutputPart
• StructuredOutputStartEvent
• SummarizationOptions
• SummarizationResult
• SummarizeAdapter
• TextAdapter
• TextCompletionChunk
• TextMessageContentEvent
• TextMessageEndEvent
• TextMessageStartEvent
• TextOptions
• TextPart
• ThinkingPart
• Tool
• ToolCall
• ToolCallArgsEvent
• ToolCallEndEvent
• ToolCallHookContext
• ToolCallPart
• ToolCallResultEvent
• ToolCallStartEvent
• ToolConfig
• ToolDefinition
• ToolDefinitionInstance
• ToolInputAvailableEvent
• ToolPhaseCompleteInfo
• ToolRegistry
• ToolResultPart
• TranscriptionAdapter
• TranscriptionOptions
• TranscriptionResult
• TranscriptionSegment
• TranscriptionWord
• TTSAdapter
• TTSOptions
• TTSResult
• UIMessage
• UIResourceEvent
• UIResourcePart
• UpsertableStreamDurability
• UsageInfo
• VADConfig
• ValidatedInterruptResumeBatch
• ValidateInterruptResumeBatchInput
• VideoAdapter
• VideoGenerationOptions
• VideoJobResult
• VideoPart
• VideoStatusResult
• VideoUrlResult

Type Aliases#

• AgentLoopStrategy
• AGUIEvent
• AGUIEventType
• AIAdapter
• AnyAudioAdapter
• AnyChatMiddleware
• AnyClientTool
• AnyEmbeddingAdapter
• AnyGenerationMiddleware
• AnyImageAdapter
• AnyRerankAdapter
• AnyServerTool
• AnySummarizeAdapter
• AnyTextAdapter
• AnyTool
• AnyTranscriptionAdapter
• AnyTTSAdapter
• AnyVideoAdapter
• ApprovalCapabilityOf
• ApprovalSchemaConfig
• ApprovalSchemaOf
• BatchInterruptErrorCode
• BeforeToolCallDecision
• Capability
• CapabilityHandle
• CapabilityProvider
• ChatMiddlewarePhase
• ChatResumeGenericResolution
• ChatStream
• ClientToolDeclaration
• ConstrainedContent
• ConstrainedModelMessage
• ContentPart
• ContentPartForInputModalitiesTypes
• ContentPartSource
• DebugOption
• DeepPartial
• EmbeddingContentParts
• EmbeddingInputItem
• EmbeddingInputItemFor
• EmbeddingModality
• EmbeddingModelInputModalitiesByName
• GeneratedAudio
• GeneratedImage
• GeneratedMediaSource
• GenerationActivity
• GenerationResultTransform
• InferSchemaType
• InferToolInput
• InferToolName
• InferToolOutput
• InputModalitiesTypes
• InputSchemaOf
• Interrupt
• InterruptBinding
• InterruptSubmissionError
• ItemInterruptErrorCode
• KnownCustomEvent
• MCPConnectionPolicy
• MediaInputRole
• MediaPrompt
• MediaPromptFor
• MediaPromptModality
• MediaPromptPart
• MergedAgentTools
• MessagePart
• ModalitiesArrayToUnion
• Modality
• ModelInputModalitiesByName
• NoSchema
• OutputSchemaOf
• PersistedArtifactActivity
• PersistedArtifactRole
• RealtimeErrorCode
• RealtimeEvent
• RealtimeEventHandler
• RealtimeMessagePart
• RealtimeMode
• RealtimeStatus
• RunAgentResumeItem
• RunFinishedOutcome
• RunStatus
• SchemaInput
• StreamChunk
• StreamChunkType
• StructuredOutputStream
• SystemPrompt
• TaggedCustomEvent
• TerminalRunStatus
• ToolApprovalResolution
• ToolCallState
• ToolDefinitionConfig
• ToolExecuteFunction
• ToolExecutionContext
• ToolOutputState
• ToolResultState
• TranscriptionResponseFormat
• TypedStreamChunk
• UnopenedInterruptBinding
• UsageTotals
• WellKnownCustomEventName
• WireMessage

Variables#

• CUSTOM_EVENT
• defaultJSONParser
• DetachableRunCapability
• DISCOVERY_TOOL_NAME
• getDetachableRun
• getRunDetached
• INTERRUPT_BINDING_METADATA_KEY
• INTERRUPT_BINDING_VERSION
• provideDetachableRun
• provideRunDetached
• RUN_ACCEPTED_EVENT
• RUN_CANCEL_REASON
• RunDetachedCapability

Functions#

• brandProviderTool
• buildBaseUsage
• canonicalInterruptJson
• canonicalizeInterruptResolutions
• chat
• chatParamsFromRequest
• chatParamsFromRequestBody
• cloneAndDeepFreezeJson
• combineStrategies
• convertMessagesToModelMessages
• convertSchemaToJsonSchema
• countEmbeddingInputModalities
• createAudioOptions
• createCapability
• createChatMiddleware
• createChatOptions
• createEmbedOptions
• createFrozenRegistry
• createImageOptions
• createModel
• createRealtimeEventEmitter
• createReplayStream
• createRerankOptions
• createSpeechOptions
• createSummarizeOptions
• createToolRegistry
• createTranscriptionOptions
• createVideoOptions
• defineChatMiddleware
• defineRunStore
• detectImageMimeType
• digestInterruptJson
• embed
• extendAdapter
• firstSentence
• generateAudio
• generateImage
• generateMessageId
• generateSpeech
• generateTranscription
• generateVideo
• generationParamsFromBody
• generationParamsFromRequest
• getProviderExecutedMetadata
• getVideoJobStatus
• hashSchemaInput
• interruptItemError
• isCancelRequestedReason
• isContentPart
• isContentPartArray
• isCustomEvent
• isProviderExecutedToolCall
• isRunStatus
• isStandardSchema
• isTerminalRunStatus
• maxIterations
• memoryStream
• mergeAgentTools
• modelMessagesToUIMessages
• modelMessageToUIMessage
• normalizeApprovalSchema
• normalizeSystemPrompts
• normalizeToolResult
• normalizeToUIMessage
• parsePartialJSON
• parseWithStandardSchema
• readInterruptBinding
• readUnopenedInterruptBinding
• realtimeToken
• renderLazyCatalogEntry
• replayRunStream
• requestRunCancel
• requireTextOnlyEmbeddingInput
• rerank
• resolveEmbeddingInput
• resolveMediaPrompt
• resolveResumeRunId
• resumeHttpResponse
• resumeServerSentEventsResponse
• streamToText
• summarize
• toHttpResponse
• toHttpStream
• toolDefinition
• toServerSentEventsResponse
• toServerSentEventsStream
• uiMessagesToWire
• uiMessageToModelMessages
• untilFinishReason
• validateInterruptResumeBatch
• validateWithStandardSchema
• wasCancelRequested
• withInterruptBinding
• withoutInterruptBinding