--- id: "@tanstack/ai" title: "@tanstack/ai" --- ## Classes - [BaseEvaluateAdapter](classes/BaseEvaluateAdapter.md) - [BaseModel3DAdapter](classes/BaseModel3DAdapter.md) - [BaseRerankAdapter](classes/BaseRerankAdapter.md) - [BatchStrategy](classes/BatchStrategy.md) - [CapabilityRegistry](classes/CapabilityRegistry.md) - [CompositeStrategy](classes/CompositeStrategy.md) - [ConsoleLogger](classes/ConsoleLogger.md) - [DuplicateToolNameError](classes/DuplicateToolNameError.md) - [EvaluateError](classes/EvaluateError.md) - [ImmediateStrategy](classes/ImmediateStrategy.md) - [InMemoryRunStore](classes/InMemoryRunStore.md) - [InterruptResumeValidationError](classes/InterruptResumeValidationError.md) - [MCPDuplicateToolNameError](classes/MCPDuplicateToolNameError.md) - [PartialJSONParser](classes/PartialJSONParser.md) - [PunctuationStrategy](classes/PunctuationStrategy.md) - [SkillLimitError](classes/SkillLimitError.md) - [StandardSchemaValidationError](classes/StandardSchemaValidationError.md) - [StreamProcessor](classes/StreamProcessor.md) - [SubagentBudget](classes/SubagentBudget.md) - [ToolCallManager](classes/ToolCallManager.md) - [WordBoundaryStrategy](classes/WordBoundaryStrategy.md) ## Interfaces - [AbortInfo](interfaces/AbortInfo.md) - [ActivityDeltaEvent](interfaces/ActivityDeltaEvent.md) - [ActivityPart](interfaces/ActivityPart.md) - [ActivityRecord](interfaces/ActivityRecord.md) - [ActivitySnapshotEvent](interfaces/ActivitySnapshotEvent.md) - [AfterToolCallInfo](interfaces/AfterToolCallInfo.md) - [AgentLoopState](interfaces/AgentLoopState.md) - [ApprovalRequestedPayload](interfaces/ApprovalRequestedPayload.md) - [ApprovalResolvedPayload](interfaces/ApprovalResolvedPayload.md) - [ArtifactCreatedPayload](interfaces/ArtifactCreatedPayload.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) - [BatchInterruptError](interfaces/BatchInterruptError.md) - [BooleanAnswer](interfaces/BooleanAnswer.md) - [BoundActivities](interfaces/BoundActivities.md) - [CancelMotionJobOptions](interfaces/CancelMotionJobOptions.md) - [CapabilityContext](interfaces/CapabilityContext.md) - [CapabilityGetter](interfaces/CapabilityGetter.md) - [CatalogVoice](interfaces/CatalogVoice.md) - [ChatMCPOptions](interfaces/ChatMCPOptions.md) - [ChatMiddleware](interfaces/ChatMiddleware.md) - [ChatMiddlewareConfig](interfaces/ChatMiddlewareConfig.md) - [ChatMiddlewareContext](interfaces/ChatMiddlewareContext.md) - [ChatResult](interfaces/ChatResult.md) - [ChatResumeToolState](interfaces/ChatResumeToolState.md) - [ChatSandboxHooks](interfaces/ChatSandboxHooks.md) - [ChoiceAnswer](interfaces/ChoiceAnswer.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) - [CodeModeSnippetCallEvent](interfaces/CodeModeSnippetCallEvent.md) - [CodeModeSnippetErrorEvent](interfaces/CodeModeSnippetErrorEvent.md) - [CodeModeSnippetResultEvent](interfaces/CodeModeSnippetResultEvent.md) - [ContentPartDataSource](interfaces/ContentPartDataSource.md) - [ContentPartFileSource](interfaces/ContentPartFileSource.md) - [ContentPartUrlSource](interfaces/ContentPartUrlSource.md) - [CustomEvent](interfaces/CustomEvent.md) - [DebugCategories](interfaces/DebugCategories.md) - [DebugConfig](interfaces/DebugConfig.md) - [DefaultMessageMetadataByModality](interfaces/DefaultMessageMetadataByModality.md) - [DefinedAgent](interfaces/DefinedAgent.md) - [DefinedChatMiddleware](interfaces/DefinedChatMiddleware.md) - [DocumentPart](interfaces/DocumentPart.md) - [Embedding](interfaces/Embedding.md) - [EmbeddingAdapter](interfaces/EmbeddingAdapter.md) - [EmbeddingOptions](interfaces/EmbeddingOptions.md) - [EmbeddingResult](interfaces/EmbeddingResult.md) - [EmitCustomEventOptions](interfaces/EmitCustomEventOptions.md) - [ErrorInfo](interfaces/ErrorInfo.md) - [EvaluateAdapter](interfaces/EvaluateAdapter.md) - [EvaluateErrorInit](interfaces/EvaluateErrorInit.md) - [ExtendedModelDef](interfaces/ExtendedModelDef.md) - [FileChangedEvent](interfaces/FileChangedEvent.md) - [FileChangedPayload](interfaces/FileChangedPayload.md) - [FileHandle](interfaces/FileHandle.md) - [FilesAdapter](interfaces/FilesAdapter.md) - [FileSourceCapable](interfaces/FileSourceCapable.md) - [FinishInfo](interfaces/FinishInfo.md) - [GeneratedVoice](interfaces/GeneratedVoice.md) - [GenerationAbortInfo](interfaces/GenerationAbortInfo.md) - [GenerationErrorInfo](interfaces/GenerationErrorInfo.md) - [GenerationFinishInfo](interfaces/GenerationFinishInfo.md) - [GenerationMiddleware](interfaces/GenerationMiddleware.md) - [GenerationMiddlewareContext](interfaces/GenerationMiddlewareContext.md) - [GenerationResultTransformContext](interfaces/GenerationResultTransformContext.md) - [GenerationUsageInfo](interfaces/GenerationUsageInfo.md) - [GenericInterruptContinuation](interfaces/GenericInterruptContinuation.md) - [ImageAdapter](interfaces/ImageAdapter.md) - [ImageGenerationOptions](interfaces/ImageGenerationOptions.md) - [ImageGenerationResult](interfaces/ImageGenerationResult.md) - [ImagePart](interfaces/ImagePart.md) - [InternalToolCallState](interfaces/InternalToolCallState.md) - [InterruptBindingDescriptor](interfaces/InterruptBindingDescriptor.md) - [InterruptCorrelation](interfaces/InterruptCorrelation.md) - [InterruptDefinition](interfaces/InterruptDefinition.md) - [InterruptDefinitionOptions](interfaces/InterruptDefinitionOptions.md) - [InterruptResolutionCollection](interfaces/InterruptResolutionCollection.md) - [ItemInterruptError](interfaces/ItemInterruptError.md) - [IterationInfo](interfaces/IterationInfo.md) - [JSONParser](interfaces/JSONParser.md) - [JSONSchema](interfaces/JSONSchema.md) - [KeyedAdapter](interfaces/KeyedAdapter.md) - [LazyToolsConfig](interfaces/LazyToolsConfig.md) - [ListVoicesOptions](interfaces/ListVoicesOptions.md) - [ListVoicesResult](interfaces/ListVoicesResult.md) - [LiveVideoAdapter](interfaces/LiveVideoAdapter.md) - [LiveVideoGenerationOptions](interfaces/LiveVideoGenerationOptions.md) - [LiveVideoGenerationResult](interfaces/LiveVideoGenerationResult.md) - [Logger](interfaces/Logger.md) - [LogRecord](interfaces/LogRecord.md) - [LogRecordsWriter](interfaces/LogRecordsWriter.md) - [MCPToolSource](interfaces/MCPToolSource.md) - [MediaInputMetadata](interfaces/MediaInputMetadata.md) - [MemoryStreamInit](interfaces/MemoryStreamInit.md) - [MemoryStreamOptions](interfaces/MemoryStreamOptions.md) - [MessageSource](interfaces/MessageSource.md) - [MessagesSnapshotEvent](interfaces/MessagesSnapshotEvent.md) - [MetadataStore](interfaces/MetadataStore.md) - [MidConversationChange](interfaces/MidConversationChange.md) - [MidConversationChanges](interfaces/MidConversationChanges.md) - [MidConversationChannels](interfaces/MidConversationChannels.md) - [MidConversationRequest](interfaces/MidConversationRequest.md) - [Model3DAdapter](interfaces/Model3DAdapter.md) - [Model3DAdapterConfig](interfaces/Model3DAdapterConfig.md) - [Model3DFile](interfaces/Model3DFile.md) - [Model3DGenerationOptions](interfaces/Model3DGenerationOptions.md) - [Model3DInputMetadata](interfaces/Model3DInputMetadata.md) - [Model3DJobResult](interfaces/Model3DJobResult.md) - [Model3DJobStatusOptions](interfaces/Model3DJobStatusOptions.md) - [Model3DJobStatusResult](interfaces/Model3DJobStatusResult.md) - [Model3DPart](interfaces/Model3DPart.md) - [Model3DResult](interfaces/Model3DResult.md) - [Model3DStatusResult](interfaces/Model3DStatusResult.md) - [ModelCapabilities](interfaces/ModelCapabilities.md) - [ModelMessage](interfaces/ModelMessage.md) - [MotionActivityOptions](interfaces/MotionActivityOptions.md) - [MotionAdapter](interfaces/MotionAdapter.md) - [MotionAsset](interfaces/MotionAsset.md) - [MotionGenerationOptions](interfaces/MotionGenerationOptions.md) - [MotionGenerationResult](interfaces/MotionGenerationResult.md) - [MotionJobResult](interfaces/MotionJobResult.md) - [MotionJobStatusOptions](interfaces/MotionJobStatusOptions.md) - [MotionJobStatusResult](interfaces/MotionJobStatusResult.md) - [MotionStatusResult](interfaces/MotionStatusResult.md) - [NormalizedApprovalSchema](interfaces/NormalizedApprovalSchema.md) - [NormalizedSchemaInput](interfaces/NormalizedSchemaInput.md) - [NormalizedSystemPrompt](interfaces/NormalizedSystemPrompt.md) - [PendingInterruptResumeRecord](interfaces/PendingInterruptResumeRecord.md) - [PersistedArtifactRef](interfaces/PersistedArtifactRef.md) - [PortOpenedPayload](interfaces/PortOpenedPayload.md) - [ProcessorResult](interfaces/ProcessorResult.md) - [ProcessorState](interfaces/ProcessorState.md) - [ProcessOutputPayload](interfaces/ProcessOutputPayload.md) - [ProviderExecutedToolMetadata](interfaces/ProviderExecutedToolMetadata.md) - [ProviderExecutedToolSource](interfaces/ProviderExecutedToolSource.md) - [ProviderKeys](interfaces/ProviderKeys.md) - [ProviderTool](interfaces/ProviderTool.md) - [RawEvent](interfaces/RawEvent.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) - [ReasoningCapability](interfaces/ReasoningCapability.md) - [ReasoningEncryptedValueEvent](interfaces/ReasoningEncryptedValueEvent.md) - [ReasoningEndEvent](interfaces/ReasoningEndEvent.md) - [ReasoningMessageChunkEvent](interfaces/ReasoningMessageChunkEvent.md) - [ReasoningMessageContentEvent](interfaces/ReasoningMessageContentEvent.md) - [ReasoningMessageEndEvent](interfaces/ReasoningMessageEndEvent.md) - [ReasoningMessageStartEvent](interfaces/ReasoningMessageStartEvent.md) - [ReasoningRequest](interfaces/ReasoningRequest.md) - [ReasoningStartEvent](interfaces/ReasoningStartEvent.md) - [RerankAdapter](interfaces/RerankAdapter.md) - [RerankAdapterResult](interfaces/RerankAdapterResult.md) - [RerankOptions](interfaces/RerankOptions.md) - [RerankResult](interfaces/RerankResult.md) - [ResolvedEmbeddingItem](interfaces/ResolvedEmbeddingItem.md) - [ResolvedMediaPrompt](interfaces/ResolvedMediaPrompt.md) - [ResolvedPromptCache](interfaces/ResolvedPromptCache.md) - [ResponseFormat](interfaces/ResponseFormat.md) - [RunArtifactRef](interfaces/RunArtifactRef.md) - [RunCheckpoint](interfaces/RunCheckpoint.md) - [RunDriverOptions](interfaces/RunDriverOptions.md) - [RunError](interfaces/RunError.md) - [RunErrorEvent](interfaces/RunErrorEvent.md) - [RunFinishedEvent](interfaces/RunFinishedEvent.md) - [RunRecord](interfaces/RunRecord.md) - [RunStartedEvent](interfaces/RunStartedEvent.md) - [RunStore](interfaces/RunStore.md) - [SandboxCreatedEvent](interfaces/SandboxCreatedEvent.md) - [SandboxFileCustomEvent](interfaces/SandboxFileCustomEvent.md) - [SandboxFileDiffEvent](interfaces/SandboxFileDiffEvent.md) - [SandboxFileEvent](interfaces/SandboxFileEvent.md) - [SandboxFileHookEvent](interfaces/SandboxFileHookEvent.md) - [SandboxLifecyclePayload](interfaces/SandboxLifecyclePayload.md) - [SandboxResumedEvent](interfaces/SandboxResumedEvent.md) - [SandboxStartingEvent](interfaces/SandboxStartingEvent.md) - [SandboxStartingPayload](interfaces/SandboxStartingPayload.md) - [Scope](interfaces/Scope.md) - [ScoreAnswer](interfaces/ScoreAnswer.md) - [ServerTool](interfaces/ServerTool.md) - [SessionIdEvent](interfaces/SessionIdEvent.md) - [SkillLimitErrorInit](interfaces/SkillLimitErrorInit.md) - [SnippetRegisteredEvent](interfaces/SnippetRegisteredEvent.md) - [StateDeltaEvent](interfaces/StateDeltaEvent.md) - [StateSnapshotEvent](interfaces/StateSnapshotEvent.md) - [StepFinishedEvent](interfaces/StepFinishedEvent.md) - [StepStartedEvent](interfaces/StepStartedEvent.md) - [StreamDurability](interfaces/StreamDurability.md) - [StreamProcessorEvents](interfaces/StreamProcessorEvents.md) - [StreamProcessorOptions](interfaces/StreamProcessorOptions.md) - [StructuredOutputCompleteEvent](interfaces/StructuredOutputCompleteEvent.md) - [StructuredOutputMiddlewareConfig](interfaces/StructuredOutputMiddlewareConfig.md) - [StructuredOutputStartEvent](interfaces/StructuredOutputStartEvent.md) - [SubagentBinding](interfaces/SubagentBinding.md) - [SubagentContextExtension](interfaces/SubagentContextExtension.md) - [SubagentErrorEvent](interfaces/SubagentErrorEvent.md) - [SubagentFinishedEvent](interfaces/SubagentFinishedEvent.md) - [SubagentForward](interfaces/SubagentForward.md) - [SubagentHandleData](interfaces/SubagentHandleData.md) - [SubagentLimits](interfaces/SubagentLimits.md) - [SubagentPart](interfaces/SubagentPart.md) - [SubagentRouteOptions](interfaces/SubagentRouteOptions.md) - [SubagentRouterPlan](interfaces/SubagentRouterPlan.md) - [SubagentRunInput](interfaces/SubagentRunInput.md) - [SubagentsBag](interfaces/SubagentsBag.md) - [SubagentSink](interfaces/SubagentSink.md) - [SubagentStartedEvent](interfaces/SubagentStartedEvent.md) - [SubagentStep](interfaces/SubagentStep.md) - [SubagentStepsPlan](interfaces/SubagentStepsPlan.md) - [SubagentWireInfo](interfaces/SubagentWireInfo.md) - [SummarizationOptions](interfaces/SummarizationOptions.md) - [SummarizationResult](interfaces/SummarizationResult.md) - [SummarizeAdapter](interfaces/SummarizeAdapter.md) - [TanStackMessageMetadata](interfaces/TanStackMessageMetadata.md) - [TanStackRunMetadata](interfaces/TanStackRunMetadata.md) - [TextAdapter](interfaces/TextAdapter.md) - [TextCompactOptions](interfaces/TextCompactOptions.md) - [TextCompletionChunk](interfaces/TextCompletionChunk.md) - [TextMessageChunkEvent](interfaces/TextMessageChunkEvent.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) - [ToolCallChunkEvent](interfaces/ToolCallChunkEvent.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) - [ToolDefinitionInstance](interfaces/ToolDefinitionInstance.md) - [ToolInputRepairContext](interfaces/ToolInputRepairContext.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) - [TTSAlignment](interfaces/TTSAlignment.md) - [TTSCapabilities](interfaces/TTSCapabilities.md) - [TTSOptions](interfaces/TTSOptions.md) - [TTSResult](interfaces/TTSResult.md) - [TTSSegment](interfaces/TTSSegment.md) - [TTSTurn](interfaces/TTSTurn.md) - [UIMessage](interfaces/UIMessage.md) - [UIResourceEvent](interfaces/UIResourceEvent.md) - [UIResourcePart](interfaces/UIResourcePart.md) - [UpsertableStreamDurability](interfaces/UpsertableStreamDurability.md) - [UsageInfo](interfaces/UsageInfo.md) - [VADConfig](interfaces/VADConfig.md) - [ValidatedInterruptResumeBatch](interfaces/ValidatedInterruptResumeBatch.md) - [ValidateInterruptResumeBatchInput](interfaces/ValidateInterruptResumeBatchInput.md) - [VideoAdapter](interfaces/VideoAdapter.md) - [VideoGenerationOptions](interfaces/VideoGenerationOptions.md) - [VideoJobResult](interfaces/VideoJobResult.md) - [VideoPart](interfaces/VideoPart.md) - [VideoStatusResult](interfaces/VideoStatusResult.md) - [VideoStreamResult](interfaces/VideoStreamResult.md) - [VideoUrlResult](interfaces/VideoUrlResult.md) - [VoiceAdapter](interfaces/VoiceAdapter.md) - [VoiceGenerationOptions](interfaces/VoiceGenerationOptions.md) - [VoiceResult](interfaces/VoiceResult.md) - [WebSocketLike](interfaces/WebSocketLike.md) - [WebSocketStreamInit](interfaces/WebSocketStreamInit.md) - [WorldAdapter](interfaces/WorldAdapter.md) - [WorldGenerationAssets](interfaces/WorldGenerationAssets.md) - [WorldGenerationOptions](interfaces/WorldGenerationOptions.md) - [WorldGenerationResult](interfaces/WorldGenerationResult.md) - [WsRunContext](interfaces/WsRunContext.md) ## Type Aliases - [AdapterReasoning](type-aliases/AdapterReasoning.md) - [AdapterYieldChunk](type-aliases/AdapterYieldChunk.md) - [AfterToolCallDecision](type-aliases/AfterToolCallDecision.md) - [AgentLoopStrategy](type-aliases/AgentLoopStrategy.md) - [AgentProduces](type-aliases/AgentProduces.md) - [AGUIEvent](type-aliases/AGUIEvent.md) - [AIAdapter](type-aliases/AIAdapter.md) - [AnyAudioAdapter](type-aliases/AnyAudioAdapter.md) - [AnyChatMiddleware](type-aliases/AnyChatMiddleware.md) - [AnyClientTool](type-aliases/AnyClientTool.md) - [AnyEmbeddingAdapter](type-aliases/AnyEmbeddingAdapter.md) - [AnyEvaluateAdapter](type-aliases/AnyEvaluateAdapter.md) - [AnyFilesAdapter](type-aliases/AnyFilesAdapter.md) - [AnyGenerationMiddleware](type-aliases/AnyGenerationMiddleware.md) - [AnyImageAdapter](type-aliases/AnyImageAdapter.md) - [AnyLiveVideoAdapter](type-aliases/AnyLiveVideoAdapter.md) - [AnyModel3DAdapter](type-aliases/AnyModel3DAdapter.md) - [AnyMotionAdapter](type-aliases/AnyMotionAdapter.md) - [AnyRerankAdapter](type-aliases/AnyRerankAdapter.md) - [AnyServerTool](type-aliases/AnyServerTool.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) - [AnyVoiceAdapter](type-aliases/AnyVoiceAdapter.md) - [AnyWorldAdapter](type-aliases/AnyWorldAdapter.md) - [ApprovalCapabilityOf](type-aliases/ApprovalCapabilityOf.md) - [ApprovalSchemaConfig](type-aliases/ApprovalSchemaConfig.md) - [ApprovalSchemaOf](type-aliases/ApprovalSchemaOf.md) - [BatchInterruptErrorCode](type-aliases/BatchInterruptErrorCode.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) - [ChatResumeGenericResolution](type-aliases/ChatResumeGenericResolution.md) - [ChatStream](type-aliases/ChatStream.md) - [ClientToolDeclaration](type-aliases/ClientToolDeclaration.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) - [EmbeddingContentParts](type-aliases/EmbeddingContentParts.md) - [EmbeddingInputItem](type-aliases/EmbeddingInputItem.md) - [EmbeddingInputItemFor](type-aliases/EmbeddingInputItemFor.md) - [EmbeddingModality](type-aliases/EmbeddingModality.md) - [EmbeddingModelInputModalitiesByName](type-aliases/EmbeddingModelInputModalitiesByName.md) - [EvaluateResult](type-aliases/EvaluateResult.md) - [FetchWrapper](type-aliases/FetchWrapper.md) - [FileUploadInput](type-aliases/FileUploadInput.md) - [GeneratedAudio](type-aliases/GeneratedAudio.md) - [GeneratedImage](type-aliases/GeneratedImage.md) - [GeneratedMediaSource](type-aliases/GeneratedMediaSource.md) - [GenerationActivity](type-aliases/GenerationActivity.md) - [GenerationResultTransform](type-aliases/GenerationResultTransform.md) - [GenericInterruptContinuationReadResult](type-aliases/GenericInterruptContinuationReadResult.md) - [GenericInterruptRequest](type-aliases/GenericInterruptRequest.md) - [GenericInterruptResolution](type-aliases/GenericInterruptResolution.md) - [GuardToolCallDecision](type-aliases/GuardToolCallDecision.md) - [InboundFrame](type-aliases/InboundFrame.md) - [InferSchemaType](type-aliases/InferSchemaType.md) - [InferToolInput](type-aliases/InferToolInput.md) - [InferToolName](type-aliases/InferToolName.md) - [InferToolOutput](type-aliases/InferToolOutput.md) - [InferToolResultMetadata](type-aliases/InferToolResultMetadata.md) - [InputModalitiesTypes](type-aliases/InputModalitiesTypes.md) - [InputSchemaOf](type-aliases/InputSchemaOf.md) - [Interrupt](type-aliases/Interrupt.md) - [InterruptBinding](type-aliases/InterruptBinding.md) - [InterruptBoundaryPhase](type-aliases/InterruptBoundaryPhase.md) - [InterruptBoundaryResult](type-aliases/InterruptBoundaryResult.md) - [InterruptResolutionResult](type-aliases/InterruptResolutionResult.md) - [InterruptSubmissionError](type-aliases/InterruptSubmissionError.md) - [InterruptToolResume](type-aliases/InterruptToolResume.md) - [ItemInterruptErrorCode](type-aliases/ItemInterruptErrorCode.md) - [KeyedAdapterResult](type-aliases/KeyedAdapterResult.md) - [KnownCustomEvent](type-aliases/KnownCustomEvent.md) - [LoadChild](type-aliases/LoadChild.md) - [MCPConnectionPolicy](type-aliases/MCPConnectionPolicy.md) - [MCPRequestMeta](type-aliases/MCPRequestMeta.md) - [MCPRequestMetaInput](type-aliases/MCPRequestMetaInput.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) - [MergedAgentTools](type-aliases/MergedAgentTools.md) - [MessagePart](type-aliases/MessagePart.md) - [ModalitiesArrayToUnion](type-aliases/ModalitiesArrayToUnion.md) - [Modality](type-aliases/Modality.md) - [Model3DActivityOptions](type-aliases/Model3DActivityOptions.md) - [Model3DActivityResult](type-aliases/Model3DActivityResult.md) - [Model3DFileRole](type-aliases/Model3DFileRole.md) - [Model3DFormat](type-aliases/Model3DFormat.md) - [Model3DPromptForAdapter](type-aliases/Model3DPromptForAdapter.md) - [Model3DProviderOptions](type-aliases/Model3DProviderOptions.md) - [ModelInputModalitiesByName](type-aliases/ModelInputModalitiesByName.md) - [ModelMessageBlock](type-aliases/ModelMessageBlock.md) - [ModelReasoning](type-aliases/ModelReasoning.md) - [MotionActivityResult](type-aliases/MotionActivityResult.md) - [MotionAssetFormat](type-aliases/MotionAssetFormat.md) - [MotionJobState](type-aliases/MotionJobState.md) - [MotionProviderOptions](type-aliases/MotionProviderOptions.md) - [NoSchema](type-aliases/NoSchema.md) - [OrderedAssistantBlock](type-aliases/OrderedAssistantBlock.md) - [OutputSchemaOf](type-aliases/OutputSchemaOf.md) - [PersistedArtifactActivity](type-aliases/PersistedArtifactActivity.md) - [PersistedArtifactRole](type-aliases/PersistedArtifactRole.md) - [PromptCacheOptions](type-aliases/PromptCacheOptions.md) - [PromptCacheRetention](type-aliases/PromptCacheRetention.md) - [ProviderKeySource](type-aliases/ProviderKeySource.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) - [ReasoningLevel](type-aliases/ReasoningLevel.md) - [ReasoningLevels](type-aliases/ReasoningLevels.md) - [ReasoningOption](type-aliases/ReasoningOption.md) - [ReasoningOptionFor](type-aliases/ReasoningOptionFor.md) - [ResultMetadataFromSchema](type-aliases/ResultMetadataFromSchema.md) - [RunAgentResumeItem](type-aliases/RunAgentResumeItem.md) - [RunFinishedOutcome](type-aliases/RunFinishedOutcome.md) - [RunKind](type-aliases/RunKind.md) - [RunStatus](type-aliases/RunStatus.md) - [SchemaInput](type-aliases/SchemaInput.md) - [StreamChunk](type-aliases/StreamChunk.md) - [StructuredOutputPart](type-aliases/StructuredOutputPart.md) - [StructuredOutputStream](type-aliases/StructuredOutputStream.md) - [SubagentChoiceOptions](type-aliases/SubagentChoiceOptions.md) - [SubagentOrder](type-aliases/SubagentOrder.md) - [SubagentPick](type-aliases/SubagentPick.md) - [SubagentRouterPick](type-aliases/SubagentRouterPick.md) - [SubagentRunContext](type-aliases/SubagentRunContext.md) - [SubagentStatus](type-aliases/SubagentStatus.md) - [SystemPrompt](type-aliases/SystemPrompt.md) - [TaggedCustomEvent](type-aliases/TaggedCustomEvent.md) - [TerminalRunStatus](type-aliases/TerminalRunStatus.md) - [ToolApprovalResolution](type-aliases/ToolApprovalResolution.md) - [ToolCallState](type-aliases/ToolCallState.md) - [ToolChoice](type-aliases/ToolChoice.md) - [ToolDefinitionConfig](type-aliases/ToolDefinitionConfig.md) - [ToolExecuteFunction](type-aliases/ToolExecuteFunction.md) - [ToolExecutionContext](type-aliases/ToolExecutionContext.md) - [ToolInputResponse](type-aliases/ToolInputResponse.md) - [ToolOutputState](type-aliases/ToolOutputState.md) - [ToolResultOutcome](type-aliases/ToolResultOutcome.md) - [ToolResultState](type-aliases/ToolResultState.md) - [TranscriptionResponseFormat](type-aliases/TranscriptionResponseFormat.md) - [UnopenedInterruptBinding](type-aliases/UnopenedInterruptBinding.md) - [VoiceOrigin](type-aliases/VoiceOrigin.md) - [VoiceTrainingStatus](type-aliases/VoiceTrainingStatus.md) - [WellKnownCustomEventName](type-aliases/WellKnownCustomEventName.md) - [WireAnswer](type-aliases/WireAnswer.md) - [WireMessage](type-aliases/WireMessage.md) - [WireQuestion](type-aliases/WireQuestion.md) ## Variables - [CONTEXT\_OVERFLOW\_CODE](variables/CONTEXT_OVERFLOW_CODE.md) - [CUSTOM\_EVENT](variables/CUSTOM_EVENT.md) - [defaultJSONParser](variables/defaultJSONParser.md) - [DetachableRunCapability](variables/DetachableRunCapability.md) - [DISCOVERY\_TOOL\_NAME](variables/DISCOVERY_TOOL_NAME.md) - [EVALUATE\_REFUSAL\_CODE](variables/EVALUATE_REFUSAL_CODE.md) - [getDetachableRun](variables/getDetachableRun.md) - [getLoadChild](variables/getLoadChild.md) - [getLogRecords](variables/getLogRecords.md) - [getMetadata](variables/getMetadata.md) - [getRunDetached](variables/getRunDetached.md) - [INTERRUPT\_BINDING\_METADATA\_KEY](variables/INTERRUPT_BINDING_METADATA_KEY.md) - [INTERRUPT\_BINDING\_VERSION](variables/INTERRUPT_BINDING_VERSION.md) - [INTERRUPT\_BOUNDARY\_PHASES](variables/INTERRUPT_BOUNDARY_PHASES.md) - [INTERRUPT\_CONTINUATION\_METADATA\_KEY](variables/INTERRUPT_CONTINUATION_METADATA_KEY.md) - [INTERRUPT\_CONTINUATION\_VERSION](variables/INTERRUPT_CONTINUATION_VERSION.md) - [INTERRUPT\_PAYLOAD\_METADATA\_KEY](variables/INTERRUPT_PAYLOAD_METADATA_KEY.md) - [INTERRUPT\_TOOL\_RESUMES](variables/INTERRUPT_TOOL_RESUMES.md) - [LoadChildCapability](variables/LoadChildCapability.md) - [LogRecordsCapability](variables/LogRecordsCapability.md) - [MetadataCapability](variables/MetadataCapability.md) - [MOTION\_EVENTS](variables/MOTION_EVENTS.md) - [provideDetachableRun](variables/provideDetachableRun.md) - [provideLoadChild](variables/provideLoadChild.md) - [provideLogRecords](variables/provideLogRecords.md) - [provideMetadata](variables/provideMetadata.md) - [provideRunDetached](variables/provideRunDetached.md) - [REASONING\_LEVELS](variables/REASONING_LEVELS.md) - [RUN\_ACCEPTED\_EVENT](variables/RUN_ACCEPTED_EVENT.md) - [RUN\_CANCEL\_REASON](variables/RUN_CANCEL_REASON.md) - [RunDetachedCapability](variables/RunDetachedCapability.md) ## Functions - [assertMessagesFileSourceSupport](functions/assertMessagesFileSourceSupport.md) - [assertPromptFileSourceSupport](functions/assertPromptFileSourceSupport.md) - [boolean](functions/boolean.md) - [brandProviderTool](functions/brandProviderTool.md) - [buildBaseUsage](functions/buildBaseUsage.md) - [cancelMotionJob](functions/cancelMotionJob.md) - [canonicalInterruptJson](functions/canonicalInterruptJson.md) - [canonicalizeInterruptResolutions](functions/canonicalizeInterruptResolutions.md) - [chat](functions/chat.md) - [chatParamsFromRequest](functions/chatParamsFromRequest.md) - [chatParamsFromRequestBody](functions/chatParamsFromRequestBody.md) - [choice](functions/choice.md) - [clampReasoningLevel](functions/clampReasoningLevel.md) - [cloneAndDeepFreezeJson](functions/cloneAndDeepFreezeJson.md) - [combineStrategies](functions/combineStrategies.md) - [compactForModel](functions/compactForModel.md) - [convertMessagesToModelMessages](functions/convertMessagesToModelMessages.md) - [convertSchemaToJsonSchema](functions/convertSchemaToJsonSchema.md) - [countEmbeddingInputModalities](functions/countEmbeddingInputModalities.md) - [create3DModelOptions](functions/create3DModelOptions.md) - [createAudioOptions](functions/createAudioOptions.md) - [createCapability](functions/createCapability.md) - [createChatMiddleware](functions/createChatMiddleware.md) - [createChatOptions](functions/createChatOptions.md) - [createEmbedOptions](functions/createEmbedOptions.md) - [createFrozenRegistry](functions/createFrozenRegistry.md) - [createImageOptions](functions/createImageOptions.md) - [createInterruptBinding](functions/createInterruptBinding.md) - [createLiveVideoOptions](functions/createLiveVideoOptions.md) - [createModel](functions/createModel.md) - [createMotionOptions](functions/createMotionOptions.md) - [createRealtimeEventEmitter](functions/createRealtimeEventEmitter.md) - [createReplayStream](functions/createReplayStream.md) - [createRerankOptions](functions/createRerankOptions.md) - [createSpeechOptions](functions/createSpeechOptions.md) - [createSubagentId](functions/createSubagentId.md) - [createSubagentSink](functions/createSubagentSink.md) - [createSummarizeOptions](functions/createSummarizeOptions.md) - [createToolRegistry](functions/createToolRegistry.md) - [createTranscriptionOptions](functions/createTranscriptionOptions.md) - [createVideoOptions](functions/createVideoOptions.md) - [createVoiceOptions](functions/createVoiceOptions.md) - [createWorldOptions](functions/createWorldOptions.md) - [decide](functions/decide.md) - [decodeWsFrame](functions/decodeWsFrame.md) - [defineAgent](functions/defineAgent.md) - [defineChatMiddleware](functions/defineChatMiddleware.md) - [defineInterrupt](functions/defineInterrupt.md) - [defineRunStore](functions/defineRunStore.md) - [deleteFile](functions/deleteFile.md) - [detectImageMimeType](functions/detectImageMimeType.md) - [digestInterruptJson](functions/digestInterruptJson.md) - [embed](functions/embed.md) - [encodeWsFrame](functions/encodeWsFrame.md) - [extendAdapter](functions/extendAdapter.md) - [fileReferenceFor](functions/fileReferenceFor.md) - [fileSourceFromHandle](functions/fileSourceFromHandle.md) - [firstSentence](functions/firstSentence.md) - [fromSpecTokenUsage](functions/fromSpecTokenUsage.md) - [generate3DModel](functions/generate3DModel.md) - [generateAudio](functions/generateAudio.md) - [generateImage](functions/generateImage.md) - [generateLiveVideo](functions/generateLiveVideo.md) - [generateMessageId](functions/generateMessageId.md) - [generateMotion](functions/generateMotion.md) - [generateSpeech](functions/generateSpeech.md) - [generateTranscription](functions/generateTranscription.md) - [generateVideo](functions/generateVideo.md) - [generateVoice](functions/generateVoice.md) - [generateWorld](functions/generateWorld.md) - [generationParamsFromBody](functions/generationParamsFromBody.md) - [generationParamsFromRequest](functions/generationParamsFromRequest.md) - [genericInterruptContinuationFromDescriptor](functions/genericInterruptContinuationFromDescriptor.md) - [get3DModelJobStatus](functions/get3DModelJobStatus.md) - [getChunkRunId](functions/getChunkRunId.md) - [getChunkThreadId](functions/getChunkThreadId.md) - [getFile](functions/getFile.md) - [getMotionJobStatus](functions/getMotionJobStatus.md) - [getProviderExecutedMetadata](functions/getProviderExecutedMetadata.md) - [getVideoJobStatus](functions/getVideoJobStatus.md) - [hashSchemaInput](functions/hashSchemaInput.md) - [interleaveActivityRecords](functions/interleaveActivityRecords.md) - [interruptItemError](functions/interruptItemError.md) - [isCancelRequestedReason](functions/isCancelRequestedReason.md) - [isContentPart](functions/isContentPart.md) - [isContentPartArray](functions/isContentPartArray.md) - [isCustomEvent](functions/isCustomEvent.md) - [isEvaluateError](functions/isEvaluateError.md) - [isFileSource](functions/isFileSource.md) - [isKeyedAdapter](functions/isKeyedAdapter.md) - [isProviderExecutedToolCall](functions/isProviderExecutedToolCall.md) - [isRunStatus](functions/isRunStatus.md) - [isStandardSchema](functions/isStandardSchema.md) - [isTerminalRunStatus](functions/isTerminalRunStatus.md) - [isToolResultOutcome](functions/isToolResultOutcome.md) - [keyedAdapter](functions/keyedAdapter.md) - [keyedAdapters](functions/keyedAdapters.md) - [listVoices](functions/listVoices.md) - [maxIterations](functions/maxIterations.md) - [memoryStream](functions/memoryStream.md) - [mergeAgentTools](functions/mergeAgentTools.md) - [mergeMetadata](functions/mergeMetadata.md) - [modelMessagesToUIMessages](functions/modelMessagesToUIMessages.md) - [modelMessageToUIMessage](functions/modelMessageToUIMessage.md) - [normalizeApprovalSchema](functions/normalizeApprovalSchema.md) - [normalizeStreamChunk](functions/normalizeStreamChunk.md) - [normalizeSystemPrompts](functions/normalizeSystemPrompts.md) - [normalizeToolResult](functions/normalizeToolResult.md) - [normalizeToUIMessage](functions/normalizeToUIMessage.md) - [orderedAssistantBlocks](functions/orderedAssistantBlocks.md) - [parsePartialJSON](functions/parsePartialJSON.md) - [parseWithStandardSchema](functions/parseWithStandardSchema.md) - [readGenericInterruptContinuation](functions/readGenericInterruptContinuation.md) - [readInterruptBinding](functions/readInterruptBinding.md) - [readUnopenedInterruptBinding](functions/readUnopenedInterruptBinding.md) - [realtimeToken](functions/realtimeToken.md) - [renderLazyCatalogEntry](functions/renderLazyCatalogEntry.md) - [replayRunStream](functions/replayRunStream.md) - [requestRunCancel](functions/requestRunCancel.md) - [requireTextOnlyEmbeddingInput](functions/requireTextOnlyEmbeddingInput.md) - [rerank](functions/rerank.md) - [resolveEmbeddingInput](functions/resolveEmbeddingInput.md) - [resolveMediaPrompt](functions/resolveMediaPrompt.md) - [resolveResumeRunId](functions/resolveResumeRunId.md) - [resumeHttpResponse](functions/resumeHttpResponse.md) - [resumeJsonResponse](functions/resumeJsonResponse.md) - [resumeServerSentEventsResponse](functions/resumeServerSentEventsResponse.md) - [resumeWebSocketResponse](functions/resumeWebSocketResponse.md) - [resumeWebSocketStream](functions/resumeWebSocketStream.md) - [runAgentStream](functions/runAgentStream.md) - [score](functions/score.md) - [splitMidConversationChanges](functions/splitMidConversationChanges.md) - [stableJson](functions/stableJson.md) - [streamToText](functions/streamToText.md) - [subagentHostMessageId](functions/subagentHostMessageId.md) - [subagentInputOf](functions/subagentInputOf.md) - [subagentRoute](functions/subagentRoute.md) - [summarize](functions/summarize.md) - [supportedReasoningLevels](functions/supportedReasoningLevels.md) - [toHttpResponse](functions/toHttpResponse.md) - [toHttpStream](functions/toHttpStream.md) - [toJsonResponse](functions/toJsonResponse.md) - [toolDefinition](functions/toolDefinition.md) - [toServerSentEventsResponse](functions/toServerSentEventsResponse.md) - [toServerSentEventsStream](functions/toServerSentEventsStream.md) - [toSpecTokenUsage](functions/toSpecTokenUsage.md) - [toWebSocketResponse](functions/toWebSocketResponse.md) - [toWebSocketStream](functions/toWebSocketStream.md) - [uiMessagesToWire](functions/uiMessagesToWire.md) - [uiMessageToModelMessages](functions/uiMessageToModelMessages.md) - [unsupportedFileSourceError](functions/unsupportedFileSourceError.md) - [untilFinishReason](functions/untilFinishReason.md) - [uploadFile](functions/uploadFile.md) - [validateInterruptResumeBatch](functions/validateInterruptResumeBatch.md) - [validateJsonSchema](functions/validateJsonSchema.md) - [validateWithStandardSchema](functions/validateWithStandardSchema.md) - [wasCancelRequested](functions/wasCancelRequested.md) - [wireSubagentInfo](functions/wireSubagentInfo.md) - [withInterruptBinding](functions/withInterruptBinding.md) - [withoutInterruptBinding](functions/withoutInterruptBinding.md) - [withTanstackMetadata](functions/withTanstackMetadata.md) - [wrapGenericInterruptContinuation](functions/wrapGenericInterruptContinuation.md)