Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

index.md

317 lines16.1 KB

1---
2id: "@tanstack/ai"
3title: "@tanstack/ai"
4---
5​
6# @tanstack/ai
7​
8## Classes
9​
10- [BatchStrategy](classes/BatchStrategy.md)
11- [CompositeStrategy](classes/CompositeStrategy.md)
12- [ConsoleLogger](classes/ConsoleLogger.md)
13- [ImmediateStrategy](classes/ImmediateStrategy.md)
14- [MCPDuplicateToolNameError](classes/MCPDuplicateToolNameError.md)
15- [PartialJSONParser](classes/PartialJSONParser.md)
16- [PunctuationStrategy](classes/PunctuationStrategy.md)
17- [StandardSchemaValidationError](classes/StandardSchemaValidationError.md)
18- [StreamProcessor](classes/StreamProcessor.md)
19- [ToolCallManager](classes/ToolCallManager.md)
20- [WordBoundaryStrategy](classes/WordBoundaryStrategy.md)
21​
22## Interfaces
23​
24- [AbortInfo](interfaces/AbortInfo.md)
25- [AfterToolCallInfo](interfaces/AfterToolCallInfo.md)
26- [AgentLoopState](interfaces/AgentLoopState.md)
27- [ApprovalRequestedEvent](interfaces/ApprovalRequestedEvent.md)
28- [AudioAdapter](interfaces/AudioAdapter.md)
29- [AudioGenerationOptions](interfaces/AudioGenerationOptions.md)
30- [AudioGenerationResult](interfaces/AudioGenerationResult.md)
31- [AudioPart](interfaces/AudioPart.md)
32- [AudioVisualization](interfaces/AudioVisualization.md)
33- [BaseAGUIEvent](interfaces/BaseAGUIEvent.md)
34- [BaseUsageInput](interfaces/BaseUsageInput.md)
35- [CapabilityContext](interfaces/CapabilityContext.md)
36- [CapabilityGetter](interfaces/CapabilityGetter.md)
37- [ChatMCPOptions](interfaces/ChatMCPOptions.md)
38- [ChatMiddleware](interfaces/ChatMiddleware.md)
39- [ChatMiddlewareConfig](interfaces/ChatMiddlewareConfig.md)
40- [ChatMiddlewareContext](interfaces/ChatMiddlewareContext.md)
41- [ChatSandboxHooks](interfaces/ChatSandboxHooks.md)
42- [ChunkRecording](interfaces/ChunkRecording.md)
43- [ChunkStrategy](interfaces/ChunkStrategy.md)
44- [ClientTool](interfaces/ClientTool.md)
45- [CodeModeConsoleEvent](interfaces/CodeModeConsoleEvent.md)
46- [CodeModeExecutionStartedEvent](interfaces/CodeModeExecutionStartedEvent.md)
47- [CodeModeExternalCallEvent](interfaces/CodeModeExternalCallEvent.md)
48- [CodeModeExternalErrorEvent](interfaces/CodeModeExternalErrorEvent.md)
49- [CodeModeExternalResultEvent](interfaces/CodeModeExternalResultEvent.md)
50- [CodeModeSkillCallEvent](interfaces/CodeModeSkillCallEvent.md)
51- [CodeModeSkillErrorEvent](interfaces/CodeModeSkillErrorEvent.md)
52- [CodeModeSkillResultEvent](interfaces/CodeModeSkillResultEvent.md)
53- [ContentPartDataSource](interfaces/ContentPartDataSource.md)
54- [ContentPartUrlSource](interfaces/ContentPartUrlSource.md)
55- [CustomEvent](interfaces/CustomEvent.md)
56- [DebugCategories](interfaces/DebugCategories.md)
57- [DebugConfig](interfaces/DebugConfig.md)
58- [DefaultMessageMetadataByModality](interfaces/DefaultMessageMetadataByModality.md)
59- [DefinedChatMiddleware](interfaces/DefinedChatMiddleware.md)
60- [DocumentPart](interfaces/DocumentPart.md)
61- [ErrorInfo](interfaces/ErrorInfo.md)
62- [ExtendedModelDef](interfaces/ExtendedModelDef.md)
63- [FileChangedEvent](interfaces/FileChangedEvent.md)
64- [FinishInfo](interfaces/FinishInfo.md)
65- [GenerationAbortInfo](interfaces/GenerationAbortInfo.md)
66- [GenerationErrorInfo](interfaces/GenerationErrorInfo.md)
67- [GenerationFinishInfo](interfaces/GenerationFinishInfo.md)
68- [GenerationMiddleware](interfaces/GenerationMiddleware.md)
69- [GenerationMiddlewareContext](interfaces/GenerationMiddlewareContext.md)
70- [GenerationUsageInfo](interfaces/GenerationUsageInfo.md)
71- [ImageAdapter](interfaces/ImageAdapter.md)
72- [ImageGenerationOptions](interfaces/ImageGenerationOptions.md)
73- [ImageGenerationResult](interfaces/ImageGenerationResult.md)
74- [ImagePart](interfaces/ImagePart.md)
75- [InternalToolCallState](interfaces/InternalToolCallState.md)
76- [IterationInfo](interfaces/IterationInfo.md)
77- [JSONParser](interfaces/JSONParser.md)
78- [JSONSchema](interfaces/JSONSchema.md)
79- [LazyToolsConfig](interfaces/LazyToolsConfig.md)
80- [Logger](interfaces/Logger.md)
81- [MCPToolSource](interfaces/MCPToolSource.md)
82- [MediaInputMetadata](interfaces/MediaInputMetadata.md)
83- [MessagesSnapshotEvent](interfaces/MessagesSnapshotEvent.md)
84- [ModelCapabilities](interfaces/ModelCapabilities.md)
85- [ModelMessage](interfaces/ModelMessage.md)
86- [NormalizedSystemPrompt](interfaces/NormalizedSystemPrompt.md)
87- [ProcessorResult](interfaces/ProcessorResult.md)
88- [ProcessorState](interfaces/ProcessorState.md)
89- [ProviderExecutedToolMetadata](interfaces/ProviderExecutedToolMetadata.md)
90- [ProviderTool](interfaces/ProviderTool.md)
91- [RealtimeAdapter](interfaces/RealtimeAdapter.md)
92- [RealtimeAudioPart](interfaces/RealtimeAudioPart.md)
93- [RealtimeConnection](interfaces/RealtimeConnection.md)
94- [RealtimeError](interfaces/RealtimeError.md)
95- [RealtimeEventPayloads](interfaces/RealtimeEventPayloads.md)
96- [RealtimeImagePart](interfaces/RealtimeImagePart.md)
97- [RealtimeMessage](interfaces/RealtimeMessage.md)
98- [RealtimeSessionConfig](interfaces/RealtimeSessionConfig.md)
99- [RealtimeTextPart](interfaces/RealtimeTextPart.md)
100- [RealtimeToken](interfaces/RealtimeToken.md)
101- [RealtimeTokenAdapter](interfaces/RealtimeTokenAdapter.md)
102- [RealtimeTokenOptions](interfaces/RealtimeTokenOptions.md)
103- [RealtimeToolCallPart](interfaces/RealtimeToolCallPart.md)
104- [RealtimeToolConfig](interfaces/RealtimeToolConfig.md)
105- [RealtimeToolResultPart](interfaces/RealtimeToolResultPart.md)
106- [ReasoningEncryptedValueEvent](interfaces/ReasoningEncryptedValueEvent.md)
107- [ReasoningEndEvent](interfaces/ReasoningEndEvent.md)
108- [ReasoningMessageContentEvent](interfaces/ReasoningMessageContentEvent.md)
109- [ReasoningMessageEndEvent](interfaces/ReasoningMessageEndEvent.md)
110- [ReasoningMessageStartEvent](interfaces/ReasoningMessageStartEvent.md)
111- [ReasoningStartEvent](interfaces/ReasoningStartEvent.md)
112- [ResolvedMediaPrompt](interfaces/ResolvedMediaPrompt.md)
113- [ResponseFormat](interfaces/ResponseFormat.md)
114- [RunErrorEvent](interfaces/RunErrorEvent.md)
115- [RunFinishedEvent](interfaces/RunFinishedEvent.md)
116- [RunStartedEvent](interfaces/RunStartedEvent.md)
117- [SandboxFileCustomEvent](interfaces/SandboxFileCustomEvent.md)
118- [SandboxFileDiffEvent](interfaces/SandboxFileDiffEvent.md)
119- [SandboxFileEvent](interfaces/SandboxFileEvent.md)
120- [SandboxFileHookEvent](interfaces/SandboxFileHookEvent.md)
121- [ServerTool](interfaces/ServerTool.md)
122- [SessionIdEvent](interfaces/SessionIdEvent.md)
123- [SkillRegisteredEvent](interfaces/SkillRegisteredEvent.md)
124- [StateDeltaEvent](interfaces/StateDeltaEvent.md)
125- [StateSnapshotEvent](interfaces/StateSnapshotEvent.md)
126- [StepFinishedEvent](interfaces/StepFinishedEvent.md)
127- [StepStartedEvent](interfaces/StepStartedEvent.md)
128- [StreamProcessorEvents](interfaces/StreamProcessorEvents.md)
129- [StreamProcessorOptions](interfaces/StreamProcessorOptions.md)
130- [StructuredOutputCompleteEvent](interfaces/StructuredOutputCompleteEvent.md)
131- [StructuredOutputMiddlewareConfig](interfaces/StructuredOutputMiddlewareConfig.md)
132- [StructuredOutputPart](interfaces/StructuredOutputPart.md)
133- [StructuredOutputStartEvent](interfaces/StructuredOutputStartEvent.md)
134- [SummarizationOptions](interfaces/SummarizationOptions.md)
135- [SummarizationResult](interfaces/SummarizationResult.md)
136- [SummarizeAdapter](interfaces/SummarizeAdapter.md)
137- [TextAdapter](interfaces/TextAdapter.md)
138- [TextCompletionChunk](interfaces/TextCompletionChunk.md)
139- [TextMessageContentEvent](interfaces/TextMessageContentEvent.md)
140- [TextMessageEndEvent](interfaces/TextMessageEndEvent.md)
141- [TextMessageStartEvent](interfaces/TextMessageStartEvent.md)
142- [TextOptions](interfaces/TextOptions.md)
143- [TextPart](interfaces/TextPart.md)
144- [ThinkingPart](interfaces/ThinkingPart.md)
145- [Tool](interfaces/Tool.md)
146- [ToolCall](interfaces/ToolCall.md)
147- [ToolCallArgsEvent](interfaces/ToolCallArgsEvent.md)
148- [ToolCallEndEvent](interfaces/ToolCallEndEvent.md)
149- [ToolCallHookContext](interfaces/ToolCallHookContext.md)
150- [ToolCallPart](interfaces/ToolCallPart.md)
151- [ToolCallResultEvent](interfaces/ToolCallResultEvent.md)
152- [ToolCallStartEvent](interfaces/ToolCallStartEvent.md)
153- [ToolConfig](interfaces/ToolConfig.md)
154- [ToolDefinition](interfaces/ToolDefinition.md)
155- [ToolDefinitionConfig](interfaces/ToolDefinitionConfig.md)
156- [ToolDefinitionInstance](interfaces/ToolDefinitionInstance.md)
157- [ToolInputAvailableEvent](interfaces/ToolInputAvailableEvent.md)
158- [ToolPhaseCompleteInfo](interfaces/ToolPhaseCompleteInfo.md)
159- [ToolRegistry](interfaces/ToolRegistry.md)
160- [ToolResultPart](interfaces/ToolResultPart.md)
161- [TranscriptionAdapter](interfaces/TranscriptionAdapter.md)
162- [TranscriptionOptions](interfaces/TranscriptionOptions.md)
163- [TranscriptionResult](interfaces/TranscriptionResult.md)
164- [TranscriptionSegment](interfaces/TranscriptionSegment.md)
165- [TranscriptionWord](interfaces/TranscriptionWord.md)
166- [TTSAdapter](interfaces/TTSAdapter.md)
167- [TTSOptions](interfaces/TTSOptions.md)
168- [TTSResult](interfaces/TTSResult.md)
169- [UIMessage](interfaces/UIMessage.md)
170- [UIResourceEvent](interfaces/UIResourceEvent.md)
171- [UIResourcePart](interfaces/UIResourcePart.md)
172- [UsageInfo](interfaces/UsageInfo.md)
173- [VADConfig](interfaces/VADConfig.md)
174- [VideoAdapter](interfaces/VideoAdapter.md)
175- [VideoGenerationOptions](interfaces/VideoGenerationOptions.md)
176- [VideoJobResult](interfaces/VideoJobResult.md)
177- [VideoPart](interfaces/VideoPart.md)
178- [VideoStatusResult](interfaces/VideoStatusResult.md)
179- [VideoUrlResult](interfaces/VideoUrlResult.md)
180​
181## Type Aliases
182​
183- [AgentLoopStrategy](type-aliases/AgentLoopStrategy.md)
184- [AGUIEvent](type-aliases/AGUIEvent.md)
185- [~~AGUIEventType~~](type-aliases/AGUIEventType.md)
186- [AIAdapter](type-aliases/AIAdapter.md)
187- [AnyAudioAdapter](type-aliases/AnyAudioAdapter.md)
188- [AnyChatMiddleware](type-aliases/AnyChatMiddleware.md)
189- [AnyClientTool](type-aliases/AnyClientTool.md)
190- [AnyGenerationMiddleware](type-aliases/AnyGenerationMiddleware.md)
191- [AnyImageAdapter](type-aliases/AnyImageAdapter.md)
192- [AnySummarizeAdapter](type-aliases/AnySummarizeAdapter.md)
193- [AnyTextAdapter](type-aliases/AnyTextAdapter.md)
194- [AnyTool](type-aliases/AnyTool.md)
195- [AnyTranscriptionAdapter](type-aliases/AnyTranscriptionAdapter.md)
196- [AnyTTSAdapter](type-aliases/AnyTTSAdapter.md)
197- [AnyVideoAdapter](type-aliases/AnyVideoAdapter.md)
198- [BeforeToolCallDecision](type-aliases/BeforeToolCallDecision.md)
199- [Capability](type-aliases/Capability.md)
200- [CapabilityHandle](type-aliases/CapabilityHandle.md)
201- [CapabilityProvider](type-aliases/CapabilityProvider.md)
202- [ChatMiddlewarePhase](type-aliases/ChatMiddlewarePhase.md)
203- [ChatStream](type-aliases/ChatStream.md)
204- [ConstrainedContent](type-aliases/ConstrainedContent.md)
205- [ConstrainedModelMessage](type-aliases/ConstrainedModelMessage.md)
206- [ContentPart](type-aliases/ContentPart.md)
207- [ContentPartForInputModalitiesTypes](type-aliases/ContentPartForInputModalitiesTypes.md)
208- [ContentPartSource](type-aliases/ContentPartSource.md)
209- [DebugOption](type-aliases/DebugOption.md)
210- [DeepPartial](type-aliases/DeepPartial.md)
211- [GeneratedAudio](type-aliases/GeneratedAudio.md)
212- [GeneratedImage](type-aliases/GeneratedImage.md)
213- [GeneratedMediaSource](type-aliases/GeneratedMediaSource.md)
214- [GenerationActivity](type-aliases/GenerationActivity.md)
215- [InferSchemaType](type-aliases/InferSchemaType.md)
216- [InferToolInput](type-aliases/InferToolInput.md)
217- [InferToolName](type-aliases/InferToolName.md)
218- [InferToolOutput](type-aliases/InferToolOutput.md)
219- [InputModalitiesTypes](type-aliases/InputModalitiesTypes.md)
220- [KnownCustomEvent](type-aliases/KnownCustomEvent.md)
221- [MCPConnectionPolicy](type-aliases/MCPConnectionPolicy.md)
222- [MediaInputRole](type-aliases/MediaInputRole.md)
223- [MediaPrompt](type-aliases/MediaPrompt.md)
224- [MediaPromptFor](type-aliases/MediaPromptFor.md)
225- [MediaPromptModality](type-aliases/MediaPromptModality.md)
226- [MediaPromptPart](type-aliases/MediaPromptPart.md)
227- [MessagePart](type-aliases/MessagePart.md)
228- [ModalitiesArrayToUnion](type-aliases/ModalitiesArrayToUnion.md)
229- [Modality](type-aliases/Modality.md)
230- [ModelInputModalitiesByName](type-aliases/ModelInputModalitiesByName.md)
231- [RealtimeErrorCode](type-aliases/RealtimeErrorCode.md)
232- [RealtimeEvent](type-aliases/RealtimeEvent.md)
233- [RealtimeEventHandler](type-aliases/RealtimeEventHandler.md)
234- [RealtimeMessagePart](type-aliases/RealtimeMessagePart.md)
235- [RealtimeMode](type-aliases/RealtimeMode.md)
236- [RealtimeStatus](type-aliases/RealtimeStatus.md)
237- [SchemaInput](type-aliases/SchemaInput.md)
238- [StreamChunk](type-aliases/StreamChunk.md)
239- [~~StreamChunkType~~](type-aliases/StreamChunkType.md)
240- [StructuredOutputStream](type-aliases/StructuredOutputStream.md)
241- [SystemPrompt](type-aliases/SystemPrompt.md)
242- [ToolCallState](type-aliases/ToolCallState.md)
243- [ToolExecuteFunction](type-aliases/ToolExecuteFunction.md)
244- [ToolExecutionContext](type-aliases/ToolExecutionContext.md)
245- [ToolOutputState](type-aliases/ToolOutputState.md)
246- [ToolResultState](type-aliases/ToolResultState.md)
247- [TranscriptionResponseFormat](type-aliases/TranscriptionResponseFormat.md)
248- [~~UsageTotals~~](type-aliases/UsageTotals.md)
249- [WireMessage](type-aliases/WireMessage.md)
250​
251## Variables
252​
253- [defaultJSONParser](variables/defaultJSONParser.md)
254- [DISCOVERY\_TOOL\_NAME](variables/DISCOVERY_TOOL_NAME.md)
255​
256## Functions
257​
258- [brandProviderTool](functions/brandProviderTool.md)
259- [buildBaseUsage](functions/buildBaseUsage.md)
260- [chat](functions/chat.md)
261- [chatParamsFromRequest](functions/chatParamsFromRequest.md)
262- [chatParamsFromRequestBody](functions/chatParamsFromRequestBody.md)
263- [combineStrategies](functions/combineStrategies.md)
264- [convertMessagesToModelMessages](functions/convertMessagesToModelMessages.md)
265- [convertSchemaToJsonSchema](functions/convertSchemaToJsonSchema.md)
266- [createAudioOptions](functions/createAudioOptions.md)
267- [createCapability](functions/createCapability.md)
268- [createChatMiddleware](functions/createChatMiddleware.md)
269- [createChatOptions](functions/createChatOptions.md)
270- [createFrozenRegistry](functions/createFrozenRegistry.md)
271- [createImageOptions](functions/createImageOptions.md)
272- [createModel](functions/createModel.md)
273- [createRealtimeEventEmitter](functions/createRealtimeEventEmitter.md)
274- [createReplayStream](functions/createReplayStream.md)
275- [createSpeechOptions](functions/createSpeechOptions.md)
276- [createSummarizeOptions](functions/createSummarizeOptions.md)
277- [createToolRegistry](functions/createToolRegistry.md)
278- [createTranscriptionOptions](functions/createTranscriptionOptions.md)
279- [createVideoOptions](functions/createVideoOptions.md)
280- [defineChatMiddleware](functions/defineChatMiddleware.md)
281- [detectImageMimeType](functions/detectImageMimeType.md)
282- [extendAdapter](functions/extendAdapter.md)
283- [firstSentence](functions/firstSentence.md)
284- [generateAudio](functions/generateAudio.md)
285- [generateImage](functions/generateImage.md)
286- [generateMessageId](functions/generateMessageId.md)
287- [generateSpeech](functions/generateSpeech.md)
288- [generateTranscription](functions/generateTranscription.md)
289- [generateVideo](functions/generateVideo.md)
290- [getProviderExecutedMetadata](functions/getProviderExecutedMetadata.md)
291- [getVideoJobStatus](functions/getVideoJobStatus.md)
292- [isContentPart](functions/isContentPart.md)
293- [isContentPartArray](functions/isContentPartArray.md)
294- [isProviderExecutedToolCall](functions/isProviderExecutedToolCall.md)
295- [isStandardSchema](functions/isStandardSchema.md)
296- [maxIterations](functions/maxIterations.md)
297- [mergeAgentTools](functions/mergeAgentTools.md)
298- [modelMessagesToUIMessages](functions/modelMessagesToUIMessages.md)
299- [modelMessageToUIMessage](functions/modelMessageToUIMessage.md)
300- [normalizeSystemPrompts](functions/normalizeSystemPrompts.md)
301- [normalizeToolResult](functions/normalizeToolResult.md)
302- [normalizeToUIMessage](functions/normalizeToUIMessage.md)
303- [parsePartialJSON](functions/parsePartialJSON.md)
304- [parseWithStandardSchema](functions/parseWithStandardSchema.md)
305- [realtimeToken](functions/realtimeToken.md)
306- [renderLazyCatalogEntry](functions/renderLazyCatalogEntry.md)
307- [resolveMediaPrompt](functions/resolveMediaPrompt.md)
308- [streamToText](functions/streamToText.md)
309- [summarize](functions/summarize.md)
310- [toHttpResponse](functions/toHttpResponse.md)
311- [toHttpStream](functions/toHttpStream.md)
312- [toolDefinition](functions/toolDefinition.md)
313- [toServerSentEventsResponse](functions/toServerSentEventsResponse.md)
314- [toServerSentEventsStream](functions/toServerSentEventsStream.md)
315- [uiMessagesToWire](functions/uiMessagesToWire.md)
316- [uiMessageToModelMessages](functions/uiMessageToModelMessages.md)
317- [untilFinishReason](functions/untilFinishReason.md)