@tanstack/ai/dist/esm/index.d.ts

Type-safe TypeScript AI SDK for streaming chat, tool calling, agents, structured outputs, and multimodal generation.

export { chat, summarize, generateImage, generateAudio, generateVideo, getVideoJobStatus, generateSpeech, generateTranscription, } from './activities/index.js';
export { createChatOptions } from './activities/chat/index.js';
export { createSummarizeOptions } from './activities/summarize/index.js';
export { createImageOptions } from './activities/generateImage/index.js';
export { createAudioOptions } from './activities/generateAudio/index.js';
export { createVideoOptions } from './activities/generateVideo/index.js';
export { createSpeechOptions } from './activities/generateSpeech/index.js';
export { createTranscriptionOptions } from './activities/generateTranscription/index.js';
export type { AIAdapter, ImageAdapter, AnyImageAdapter, TextAdapter, AnyTextAdapter, AnySummarizeAdapter, SummarizeAdapter, AnyAudioAdapter, AudioAdapter, AnyTTSAdapter, TTSAdapter, AnyTranscriptionAdapter, TranscriptionAdapter, AnyVideoAdapter, VideoAdapter, } from './activities/index.js';
export { toolDefinition, type ToolDefinition, type ToolDefinitionInstance, type ToolDefinitionConfig, type ServerTool, type AnyServerTool, type ClientTool, type AnyClientTool, type InferToolName, type InferToolInput, type InferToolOutput, type ApprovalCapabilityOf, type ApprovalSchemaConfig, type ApprovalSchemaOf, type InputSchemaOf, type OutputSchemaOf, type NoSchema, } from './activities/chat/tools/tool-definition.js';
export { hashSchemaInput, normalizeApprovalSchema, type NormalizedApprovalSchema, type NormalizedSchemaInput, } from './activities/chat/tools/approval-schema.js';
export { canonicalInterruptJson, cloneAndDeepFreezeJson, digestInterruptJson, } from './interrupt-serialization.js';
export { INTERRUPT_BINDING_METADATA_KEY, InterruptResumeValidationError, interruptItemError, readInterruptBinding, readUnopenedInterruptBinding, validateInterruptResumeBatch, withInterruptBinding, withoutInterruptBinding, type PendingInterruptResumeRecord, type ValidateInterruptResumeBatchInput, type ValidatedInterruptResumeBatch, } from './interrupt-resume.js';
export type { MCPToolSource, ChatMCPOptions, MCPConnectionPolicy, } from './activities/chat/mcp/types.js';
export { MCPDuplicateToolNameError } from './activities/chat/mcp/manager.js';
export { convertSchemaToJsonSchema, isStandardSchema, parseWithStandardSchema, validateWithStandardSchema, StandardSchemaValidationError, } from './activities/chat/tools/schema-converter.js';
export { streamToText, toServerSentEventsStream, toServerSentEventsResponse, resumeServerSentEventsResponse, toHttpStream, toHttpResponse, resumeHttpResponse, resolveResumeRunId, RUN_ACCEPTED_EVENT, } from './stream-to-response.js';
export type { RunDriverOptions } from './stream-to-response.js';
export { memoryStream, replayRunStream } from './stream-durability.js';
export type { MemoryStreamInit, MemoryStreamOptions, StreamDurability, UpsertableStreamDurability, } from './stream-durability.js';
export { ToolCallManager } from './activities/chat/tools/tool-calls.js';
export { DISCOVERY_TOOL_NAME } from './activities/chat/tools/lazy-tool-manager.js';
export type { ProviderTool } from './tools/provider-tool.js';
export { brandProviderTool } from './tools/provider-tool.js';
export { maxIterations, untilFinishReason, combineStrategies, } from './activities/chat/agent-loop-strategies.js';
export { createToolRegistry, createFrozenRegistry, type ToolRegistry, } from './tool-registry.js';
export type { ChatMiddleware, ChatMiddlewareContext, ChatMiddlewarePhase, ChatMiddlewareConfig, ChatResumeToolState, ChatResumeGenericResolution, StructuredOutputMiddlewareConfig, ToolCallHookContext, BeforeToolCallDecision, AfterToolCallInfo, IterationInfo, ToolPhaseCompleteInfo, UsageInfo, FinishInfo, AbortInfo, ErrorInfo, SandboxFileEvent, SandboxFileHookEvent, ChatSandboxHooks, } from './activities/chat/middleware/index.js';
export { INTERRUPT_BINDING_VERSION, canonicalizeInterruptResolutions, } from './interrupts.js';
export type { BatchInterruptError, BatchInterruptErrorCode, InterruptBinding, InterruptCorrelation, InterruptSubmissionError, ItemInterruptError, ItemInterruptErrorCode, ToolApprovalResolution, UnopenedInterruptBinding, } from './interrupts.js';
export type { GenerationMiddleware, GenerationMiddlewareContext, GenerationActivity, GenerationUsageInfo, GenerationFinishInfo, GenerationAbortInfo, GenerationErrorInfo, AnyGenerationMiddleware, GenerationResultTransform, GenerationResultTransformContext, } from './activities/middleware/index.js';
export { createCapability, defineChatMiddleware, createChatMiddleware, } from './activities/chat/middleware/index.js';
export type { Capability, CapabilityHandle, CapabilityContext, CapabilityGetter, CapabilityProvider, DefinedChatMiddleware, AnyChatMiddleware, } from './activities/chat/middleware/index.js';
export { isRunStatus, isTerminalRunStatus, defineRunStore, InMemoryRunStore, } from './activities/chat/middleware/index.js';
export type { RunStatus, TerminalRunStatus, RunRecord, RunError, RunStore, } from './activities/chat/middleware/index.js';
export { DetachableRunCapability, getDetachableRun, provideDetachableRun, } from './activities/chat/middleware/run-store.js';
export { RunDetachedCapability, getRunDetached, provideRunDetached, } from './activities/chat/middleware/run-store.js';
export { RUN_CANCEL_REASON, isCancelRequestedReason, requestRunCancel, wasCancelRequested, } from './activities/chat/cancel.js';
export { CUSTOM_EVENT, isCustomEvent } from './custom-events.js';
export type { WellKnownCustomEventName, FileChangedPayload, ProcessOutputPayload, PortOpenedPayload, ApprovalRequestedPayload, ApprovalResolvedPayload, ArtifactCreatedPayload, SandboxLifecyclePayload, } from './custom-events.js';
export * from './types.js';
export type { Scope } from './scope.js';
export { firstSentence, renderLazyCatalogEntry, } from './activities/chat/tools/lazy-tools.js';
export { buildBaseUsage, type BaseUsageInput } from './utilities/usage.js';
export { resolveMediaPrompt } from './utilities/media-prompt.js';
export type { ResolvedMediaPrompt } from './utilities/media-prompt.js';
export type { SystemPrompt, NormalizedSystemPrompt } from './system-prompts.js';
export { normalizeSystemPrompts } from './system-prompts.js';
export { detectImageMimeType } from './utils.js';
export { realtimeToken, createRealtimeEventEmitter } from './realtime/index.js';
export type { RealtimeToken, RealtimeTokenAdapter, RealtimeTokenOptions, RealtimeSessionConfig, RealtimeToolConfig, VADConfig, RealtimeMessage, RealtimeMessagePart, RealtimeTextPart, RealtimeAudioPart, RealtimeToolCallPart, RealtimeToolResultPart, RealtimeImagePart, RealtimeStatus, RealtimeMode, AudioVisualization, RealtimeEvent, RealtimeEventPayloads, RealtimeEventHandler, RealtimeErrorCode, RealtimeError, RealtimeAdapter, RealtimeConnection, } from './realtime/index.js';
export { convertMessagesToModelMessages, generateMessageId, uiMessageToModelMessages, modelMessageToUIMessage, modelMessagesToUIMessages, normalizeToUIMessage, } from './activities/chat/messages.js';
export { StreamProcessor, createReplayStream, ImmediateStrategy, PunctuationStrategy, BatchStrategy, WordBoundaryStrategy, CompositeStrategy, PartialJSONParser, defaultJSONParser, parsePartialJSON, } from './activities/chat/stream/index.js';
export type { ChunkStrategy, ChunkRecording, InternalToolCallState, ProcessorResult, ProcessorState, StreamProcessorEvents, StreamProcessorOptions, ToolCallState, ToolResultState, JSONParser, } from './activities/chat/stream/index.js';
export { chatParamsFromRequest, chatParamsFromRequestBody, mergeAgentTools, } from './utilities/chat-params.js';
export type { ClientToolDeclaration, MergedAgentTools, } from './utilities/chat-params.js';
export { generationParamsFromBody, generationParamsFromRequest } from './client.js';
export { uiMessagesToWire } from './utilities/ag-ui-wire.js';
export type { WireMessage } from './utilities/ag-ui-wire.js';
export { isContentPart, isContentPartArray, normalizeToolResult, } from './utilities/tool-result.js';
export { getProviderExecutedMetadata, isProviderExecutedToolCall, } from './utilities/provider-executed.js';
export { createModel, extendAdapter } from './extend-adapter.js';
export type { ExtendedModelDef, ModelCapabilities } from './extend-adapter.js';
export type { Logger, DebugCategories, DebugConfig, DebugOption, } from './logger/types.js';
export { ConsoleLogger } from './logger/console-logger.js';