AI Docs
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference.md
@tanstack/ai
Classes#
- BaseEvaluateAdapter
- BaseRerankAdapter
- BatchStrategy
- CapabilityRegistry
- CompositeStrategy
- ConsoleLogger
- DuplicateToolNameError
- ImmediateStrategy
- InMemoryRunStore
- InterruptResumeValidationError
- MCPDuplicateToolNameError
- PartialJSONParser
- PunctuationStrategy
- SkillLimitError
- StandardSchemaValidationError
- StreamProcessor
- ToolCallManager
- WordBoundaryStrategy
Interfaces#
- AbortInfo
- ActivityDeltaEvent
- ActivityPart
- ActivityRecord
- ActivitySnapshotEvent
- AfterToolCallInfo
- AgentLoopState
ApprovalRequestedEvent- ApprovalRequestedPayload
- ApprovalResolvedPayload
- ArtifactCreatedPayload
- AudioAdapter
- AudioGenerationOptions
- AudioGenerationResult
- AudioPart
- AudioVisualization
- BaseAGUIEvent
- BaseUsageInput
- BatchInterruptError
- BooleanAnswer
- CapabilityContext
- CapabilityGetter
- CatalogVoice
- ChatMCPOptions
- ChatMiddleware
- ChatMiddlewareConfig
- ChatMiddlewareContext
- ChatResult
- ChatResumeToolState
- ChatSandboxHooks
- ChoiceAnswer
- ChunkRecording
- ChunkStrategy
- ClientTool
- CodeModeConsoleEvent
- CodeModeExecutionStartedEvent
- CodeModeExternalCallEvent
- CodeModeExternalErrorEvent
- CodeModeExternalResultEvent
- CodeModeSnippetCallEvent
- CodeModeSnippetErrorEvent
- CodeModeSnippetResultEvent
- ContentPartDataSource
- ContentPartFileSource
- ContentPartUrlSource
- CustomEvent
- DebugCategories
- DebugConfig
- DefaultMessageMetadataByModality
- DefinedAgent
- DefinedChatMiddleware
- DocumentPart
- Embedding
- EmbeddingAdapter
- EmbeddingOptions
- EmbeddingResult
- EmitCustomEventOptions
- ErrorInfo
- EvaluateAdapter
- ExtendedModelDef
- FileChangedEvent
- FileChangedPayload
- FileHandle
- FilesAdapter
- FileSourceCapable
- FinishInfo
- GeneratedVoice
- GenerationAbortInfo
- GenerationErrorInfo
- GenerationFinishInfo
- GenerationMiddleware
- GenerationMiddlewareContext
- GenerationResultTransformContext
- GenerationUsageInfo
- GenericInterruptContinuation
- ImageAdapter
- ImageGenerationOptions
- ImageGenerationResult
- ImagePart
- InternalToolCallState
- InterruptBindingDescriptor
- InterruptCorrelation
- InterruptDefinition
- InterruptDefinitionOptions
- InterruptResolutionCollection
- ItemInterruptError
- IterationInfo
- JSONParser
- JSONSchema
- KeyedAdapter
- LazyToolsConfig
- ListVoicesOptions
- ListVoicesResult
- LiveVideoAdapter
- LiveVideoGenerationOptions
- LiveVideoGenerationResult
- Logger
- LogRecord
- LogRecordsWriter
- MCPToolSource
- MediaInputMetadata
- MemoryStreamInit
- MemoryStreamOptions
- MessageSource
- MessagesSnapshotEvent
- MetadataStore
- MidConversationChange
- MidConversationChanges
- MidConversationChannels
- MidConversationRequest
- ModelCapabilities
- ModelMessage
- NormalizedApprovalSchema
- NormalizedSchemaInput
- NormalizedSystemPrompt
- PendingInterruptResumeRecord
- PersistedArtifactRef
- PortOpenedPayload
- ProcessorResult
- ProcessorState
- ProcessOutputPayload
- ProviderExecutedToolMetadata
- ProviderExecutedToolSource
- ProviderTool
- RawEvent
- RealtimeAdapter
- RealtimeAudioPart
- RealtimeConnection
- RealtimeError
- RealtimeEventPayloads
- RealtimeImagePart
- RealtimeMessage
- RealtimeSessionConfig
- RealtimeTextPart
- RealtimeToken
- RealtimeTokenAdapter
- RealtimeTokenOptions
- RealtimeToolCallPart
- RealtimeToolConfig
- RealtimeToolResultPart
- ReasoningCapability
- ReasoningEncryptedValueEvent
- ReasoningEndEvent
- ReasoningMessageChunkEvent
- ReasoningMessageContentEvent
- ReasoningMessageEndEvent
- ReasoningMessageStartEvent
- ReasoningRequest
- ReasoningStartEvent
- RerankAdapter
- RerankAdapterResult
- RerankOptions
- RerankResult
- ResolvedEmbeddingItem
- ResolvedMediaPrompt
- ResolvedPromptCache
- ResponseFormat
- RunDriverOptions
- RunError
- RunErrorEvent
- RunFinishedEvent
- RunRecord
- RunStartedEvent
- RunStore
- SandboxFileCustomEvent
- SandboxFileDiffEvent
- SandboxFileEvent
- SandboxFileHookEvent
- SandboxLifecyclePayload
- Scope
- ScoreAnswer
- ServerTool
- SessionIdEvent
- SkillLimitErrorInit
- SnippetRegisteredEvent
- StateDeltaEvent
- StateSnapshotEvent
- StepFinishedEvent
- StepStartedEvent
- StreamDurability
- StreamProcessorEvents
- StreamProcessorOptions
- StructuredOutputCompleteEvent
- StructuredOutputMiddlewareConfig
- StructuredOutputStartEvent
- SubagentErrorEvent
- SubagentFinishedEvent
- SubagentHandleData
- SubagentPart
- SubagentRouteOptions
- SubagentRouterPlan
- SubagentRunContext
- SubagentsBag
- SubagentSink
- SubagentStartedEvent
- SubagentStep
- SubagentStepsPlan
- SubagentWireInfo
- SummarizationOptions
- SummarizationResult
- SummarizeAdapter
- TanStackMessageMetadata
- TanStackRunMetadata
- TextAdapter
- TextCompactOptions
- TextCompletionChunk
- TextMessageChunkEvent
- TextMessageContentEvent
- TextMessageEndEvent
- TextMessageStartEvent
- TextOptions
- TextPart
- ThinkingPart
- Tool
- ToolCall
- ToolCallArgsEvent
- ToolCallChunkEvent
- ToolCallEndEvent
- ToolCallHookContext
- ToolCallPart
- ToolCallResultEvent
- ToolCallStartEvent
- ToolConfig
- ToolDefinition
- ToolDefinitionInstance
ToolInputAvailableEvent- ToolPhaseCompleteInfo
- ToolRegistry
- ToolResultPart
- TranscriptionAdapter
- TranscriptionOptions
- TranscriptionResult
- TranscriptionSegment
- TranscriptionWord
- TTSAdapter
- TTSAlignment
- TTSCapabilities
- TTSOptions
- TTSResult
- TTSSegment
- TTSTurn
- UIMessage
- UIResourceEvent
- UIResourcePart
- UpsertableStreamDurability
- UsageInfo
- VADConfig
- ValidatedInterruptResumeBatch
- ValidateInterruptResumeBatchInput
- VideoAdapter
- VideoGenerationOptions
- VideoJobResult
- VideoPart
- VideoStatusResult
- VideoStreamResult
- VideoUrlResult
- VoiceAdapter
- VoiceGenerationOptions
- VoiceResult
- WebSocketLike
- WebSocketStreamInit
- WorldAdapter
- WorldGenerationAssets
- WorldGenerationOptions
- WorldGenerationResult
- WsRunContext
Type Aliases#
- AdapterReasoning
- AdapterYieldChunk
- AfterToolCallDecision
- AgentLoopStrategy
- AGUIEvent
AGUIEventType- AIAdapter
- AnyAudioAdapter
- AnyChatMiddleware
- AnyClientTool
- AnyEmbeddingAdapter
- AnyEvaluateAdapter
- AnyFilesAdapter
- AnyGenerationMiddleware
- AnyImageAdapter
- AnyLiveVideoAdapter
- AnyRerankAdapter
- AnyServerTool
- AnySummarizeAdapter
- AnyTextAdapter
- AnyTool
- AnyTranscriptionAdapter
- AnyTTSAdapter
- AnyVideoAdapter
- AnyVoiceAdapter
- AnyWorldAdapter
- ApprovalCapabilityOf
- ApprovalSchemaConfig
- ApprovalSchemaOf
- BatchInterruptErrorCode
- BeforeToolCallDecision
- Capability
- CapabilityHandle
- CapabilityProvider
- ChatMiddlewarePhase
- ChatResumeGenericResolution
- ChatStream
- ClientToolDeclaration
- ConstrainedContent
- ConstrainedModelMessage
- ContentPart
- ContentPartForInputModalitiesTypes
- ContentPartSource
- DebugOption
- DeepPartial
- EmbeddingContentParts
- EmbeddingInputItem
- EmbeddingInputItemFor
- EmbeddingModality
- EmbeddingModelInputModalitiesByName
- EvaluateResult
- FetchWrapper
- FileUploadInput
- GeneratedAudio
- GeneratedImage
- GeneratedMediaSource
- GenerationActivity
- GenerationResultTransform
- GenericInterruptContinuationReadResult
- GenericInterruptRequest
- GenericInterruptResolution
- InboundFrame
- InferSchemaType
- InferToolInput
- InferToolName
- InferToolOutput
- InputModalitiesTypes
- InputSchemaOf
- Interrupt
- InterruptBinding
- InterruptBoundaryPhase
- InterruptBoundaryResult
- InterruptResolutionResult
- InterruptSubmissionError
- InterruptToolResume
- ItemInterruptErrorCode
- KeyedAdapterResult
- KnownCustomEvent
- MCPConnectionPolicy
- MediaInputRole
- MediaPrompt
- MediaPromptFor
- MediaPromptModality
- MediaPromptPart
- MergedAgentTools
- MessagePart
- ModalitiesArrayToUnion
- Modality
- ModelInputModalitiesByName
- ModelMessageBlock
- ModelReasoning
- NoSchema
- OrderedAssistantBlock
- OutputSchemaOf
- PersistedArtifactActivity
- PersistedArtifactRole
- PromptCacheOptions
- PromptCacheRetention
- RealtimeErrorCode
- RealtimeEvent
- RealtimeEventHandler
- RealtimeMessagePart
- RealtimeMode
- RealtimeStatus
- ReasoningLevel
- ReasoningLevels
- ReasoningOption
- ReasoningOptionFor
- RunAgentResumeItem
- RunFinishedOutcome
- RunStatus
- SchemaInput
- StreamChunk
StreamChunkType- StructuredOutputPart
- StructuredOutputStream
- SubagentChoiceOptions
- SubagentOrder
- SubagentPick
- SubagentRouterPick
- SubagentStatus
- SystemPrompt
- TaggedCustomEvent
- TerminalRunStatus
- ToolApprovalResolution
- ToolCallState
- ToolChoice
- ToolDefinitionConfig
- ToolExecuteFunction
- ToolExecutionContext
- ToolInputResponse
- ToolOutputState
- ToolResultOutcome
- ToolResultState
- TranscriptionResponseFormat
- UnopenedInterruptBinding
UsageTotals- VoiceOrigin
- VoiceTrainingStatus
- WellKnownCustomEventName
- WireAnswer
- WireMessage
- WireQuestion
Variables#
- CONTEXT_OVERFLOW_CODE
- CUSTOM_EVENT
- defaultJSONParser
- DetachableRunCapability
- DISCOVERY_TOOL_NAME
- getDetachableRun
- getLogRecords
- getMetadata
- getRunDetached
- INTERRUPT_BINDING_METADATA_KEY
- INTERRUPT_BINDING_VERSION
- INTERRUPT_BOUNDARY_PHASES
- INTERRUPT_CONTINUATION_METADATA_KEY
- INTERRUPT_CONTINUATION_VERSION
- INTERRUPT_PAYLOAD_METADATA_KEY
- INTERRUPT_TOOL_RESUMES
- LogRecordsCapability
- MetadataCapability
- provideDetachableRun
- provideLogRecords
- provideMetadata
- provideRunDetached
- REASONING_LEVELS
- RUN_ACCEPTED_EVENT
- RUN_CANCEL_REASON
- RunDetachedCapability
Functions#
- assertMessagesFileSourceSupport
- assertPromptFileSourceSupport
- boolean
- brandProviderTool
- buildBaseUsage
- canonicalInterruptJson
- canonicalizeInterruptResolutions
- chat
- chatParamsFromRequest
- chatParamsFromRequestBody
- choice
- clampReasoningLevel
- cloneAndDeepFreezeJson
- combineStrategies
- convertMessagesToModelMessages
- convertSchemaToJsonSchema
- countEmbeddingInputModalities
- createAudioOptions
- createCapability
- createChatMiddleware
- createChatOptions
- createEmbedOptions
- createFrozenRegistry
- createImageOptions
- createInterruptBinding
- createLiveVideoOptions
- createModel
- createRealtimeEventEmitter
- createReplayStream
- createRerankOptions
- createSpeechOptions
- createSubagentId
- createSubagentSink
- createSummarizeOptions
- createToolRegistry
- createTranscriptionOptions
- createVideoOptions
- createVoiceOptions
- createWorldOptions
- decide
- decodeWsFrame
- defineAgent
- defineChatMiddleware
- defineInterrupt
- defineRunStore
- deleteFile
- detectImageMimeType
- digestInterruptJson
- embed
- encodeWsFrame
- extendAdapter
- fileReferenceFor
- fileSourceFromHandle
- firstSentence
- fromSpecTokenUsage
- generateAudio
- generateImage
- generateLiveVideo
- generateMessageId
- generateSpeech
- generateTranscription
- generateVideo
- generateVoice
- generateWorld
- generationParamsFromBody
- generationParamsFromRequest
- genericInterruptContinuationFromDescriptor
- getChunkRunId
- getChunkThreadId
- getFile
- getProviderExecutedMetadata
- getVideoJobStatus
- hashSchemaInput
- interleaveActivityRecords
- interruptItemError
- isCancelRequestedReason
- isContentPart
- isContentPartArray
- isCustomEvent
- isFileSource
- isKeyedAdapter
- isProviderExecutedToolCall
- isRunStatus
- isStandardSchema
- isTerminalRunStatus
- isToolResultOutcome
- keyedAdapter
- keyedAdapters
- listVoices
- maxIterations
- memoryStream
- mergeAgentTools
- mergeMetadata
- modelMessagesToUIMessages
- modelMessageToUIMessage
- normalizeApprovalSchema
- normalizeStreamChunk
- normalizeSystemPrompts
- normalizeToolResult
- normalizeToUIMessage
- orderedAssistantBlocks
- parsePartialJSON
- parseWithStandardSchema
- readGenericInterruptContinuation
- readInterruptBinding
- readUnopenedInterruptBinding
- realtimeToken
- renderLazyCatalogEntry
- replayRunStream
- requestRunCancel
- requireTextOnlyEmbeddingInput
- rerank
- resolveEmbeddingInput
- resolveMediaPrompt
- resolveResumeRunId
- resumeHttpResponse
- resumeJsonResponse
- resumeServerSentEventsResponse
- resumeWebSocketResponse
- resumeWebSocketStream
- runAgentStream
- score
- splitMidConversationChanges
- streamToText
- subagentHostMessageId
- subagentRoute
- summarize
- supportedReasoningLevels
- toHttpResponse
- toHttpStream
- toJsonResponse
- toolDefinition
- toServerSentEventsResponse
- toServerSentEventsStream
- toSpecTokenUsage
- toWebSocketResponse
- toWebSocketStream
- uiMessagesToWire
- uiMessageToModelMessages
- unsupportedFileSourceError
- untilFinishReason
- uploadFile
- validateInterruptResumeBatch
- validateWithStandardSchema
- wasCancelRequested
- wireSubagentInfo
- withInterruptBinding
- withoutInterruptBinding
- withTanstackMetadata
- wrapGenericInterruptContinuation