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

index.md

151 lines6.9 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- [ImmediateStrategy](classes/ImmediateStrategy.md)
13- [PartialJSONParser](classes/PartialJSONParser.md)
14- [PunctuationStrategy](classes/PunctuationStrategy.md)
15- [StreamProcessor](classes/StreamProcessor.md)
16- [ToolCallManager](classes/ToolCallManager.md)
17- [WordBoundaryStrategy](classes/WordBoundaryStrategy.md)
18​
19## Interfaces
20​
21- [AgentLoopState](interfaces/AgentLoopState.md)
22- [ApprovalRequestedStreamChunk](interfaces/ApprovalRequestedStreamChunk.md)
23- [AudioPart](interfaces/AudioPart.md)
24- [BaseStreamChunk](interfaces/BaseStreamChunk.md)
25- [ChunkRecording](interfaces/ChunkRecording.md)
26- [ChunkStrategy](interfaces/ChunkStrategy.md)
27- [ClientTool](interfaces/ClientTool.md)
28- [ContentPartSource](interfaces/ContentPartSource.md)
29- [ContentStreamChunk](interfaces/ContentStreamChunk.md)
30- [DefaultMessageMetadataByModality](interfaces/DefaultMessageMetadataByModality.md)
31- [DocumentPart](interfaces/DocumentPart.md)
32- [DoneStreamChunk](interfaces/DoneStreamChunk.md)
33- [ErrorStreamChunk](interfaces/ErrorStreamChunk.md)
34- [GeneratedImage](interfaces/GeneratedImage.md)
35- [ImageAdapter](interfaces/ImageAdapter.md)
36- [ImageGenerationOptions](interfaces/ImageGenerationOptions.md)
37- [ImageGenerationResult](interfaces/ImageGenerationResult.md)
38- [ImagePart](interfaces/ImagePart.md)
39- [InternalToolCallState](interfaces/InternalToolCallState.md)
40- [JSONParser](interfaces/JSONParser.md)
41- [JSONSchema](interfaces/JSONSchema.md)
42- [ModelMessage](interfaces/ModelMessage.md)
43- [ProcessorResult](interfaces/ProcessorResult.md)
44- [ProcessorState](interfaces/ProcessorState.md)
45- [ResponseFormat](interfaces/ResponseFormat.md)
46- [ServerTool](interfaces/ServerTool.md)
47- [StreamProcessorEvents](interfaces/StreamProcessorEvents.md)
48- [StreamProcessorHandlers](interfaces/StreamProcessorHandlers.md)
49- [StreamProcessorOptions](interfaces/StreamProcessorOptions.md)
50- [SummarizationOptions](interfaces/SummarizationOptions.md)
51- [SummarizationResult](interfaces/SummarizationResult.md)
52- [SummarizeAdapter](interfaces/SummarizeAdapter.md)
53- [TextAdapter](interfaces/TextAdapter.md)
54- [TextCompletionChunk](interfaces/TextCompletionChunk.md)
55- [TextOptions](interfaces/TextOptions.md)
56- [TextPart](interfaces/TextPart.md)
57- [ThinkingPart](interfaces/ThinkingPart.md)
58- [ThinkingStreamChunk](interfaces/ThinkingStreamChunk.md)
59- [Tool](interfaces/Tool.md)
60- [ToolCall](interfaces/ToolCall.md)
61- [ToolCallPart](interfaces/ToolCallPart.md)
62- [ToolCallStreamChunk](interfaces/ToolCallStreamChunk.md)
63- [ToolConfig](interfaces/ToolConfig.md)
64- [ToolDefinition](interfaces/ToolDefinition.md)
65- [ToolDefinitionConfig](interfaces/ToolDefinitionConfig.md)
66- [ToolDefinitionInstance](interfaces/ToolDefinitionInstance.md)
67- [ToolInputAvailableStreamChunk](interfaces/ToolInputAvailableStreamChunk.md)
68- [ToolResultPart](interfaces/ToolResultPart.md)
69- [ToolResultStreamChunk](interfaces/ToolResultStreamChunk.md)
70- [TranscriptionAdapter](interfaces/TranscriptionAdapter.md)
71- [TranscriptionOptions](interfaces/TranscriptionOptions.md)
72- [TranscriptionResult](interfaces/TranscriptionResult.md)
73- [TranscriptionSegment](interfaces/TranscriptionSegment.md)
74- [TranscriptionWord](interfaces/TranscriptionWord.md)
75- [TTSAdapter](interfaces/TTSAdapter.md)
76- [TTSOptions](interfaces/TTSOptions.md)
77- [TTSResult](interfaces/TTSResult.md)
78- [UIMessage](interfaces/UIMessage.md)
79- [VideoAdapter](interfaces/VideoAdapter.md)
80- [VideoGenerationOptions](interfaces/VideoGenerationOptions.md)
81- [VideoJobResult](interfaces/VideoJobResult.md)
82- [VideoPart](interfaces/VideoPart.md)
83- [VideoStatusResult](interfaces/VideoStatusResult.md)
84- [VideoUrlResult](interfaces/VideoUrlResult.md)
85​
86## Type Aliases
87​
88- [AgentLoopStrategy](type-aliases/AgentLoopStrategy.md)
89- [AIAdapter](type-aliases/AIAdapter.md)
90- [AnyClientTool](type-aliases/AnyClientTool.md)
91- [AnyImageAdapter](type-aliases/AnyImageAdapter.md)
92- [AnySummarizeAdapter](type-aliases/AnySummarizeAdapter.md)
93- [AnyTextAdapter](type-aliases/AnyTextAdapter.md)
94- [AnyTranscriptionAdapter](type-aliases/AnyTranscriptionAdapter.md)
95- [AnyTTSAdapter](type-aliases/AnyTTSAdapter.md)
96- [AnyVideoAdapter](type-aliases/AnyVideoAdapter.md)
97- [ConstrainedContent](type-aliases/ConstrainedContent.md)
98- [ConstrainedModelMessage](type-aliases/ConstrainedModelMessage.md)
99- [ContentPart](type-aliases/ContentPart.md)
100- [ContentPartForInputModalitiesTypes](type-aliases/ContentPartForInputModalitiesTypes.md)
101- [InferSchemaType](type-aliases/InferSchemaType.md)
102- [InferToolInput](type-aliases/InferToolInput.md)
103- [InferToolName](type-aliases/InferToolName.md)
104- [InferToolOutput](type-aliases/InferToolOutput.md)
105- [InputModalitiesTypes](type-aliases/InputModalitiesTypes.md)
106- [MessagePart](type-aliases/MessagePart.md)
107- [ModalitiesArrayToUnion](type-aliases/ModalitiesArrayToUnion.md)
108- [Modality](type-aliases/Modality.md)
109- [SchemaInput](type-aliases/SchemaInput.md)
110- [StreamChunk](type-aliases/StreamChunk.md)
111- [StreamChunkType](type-aliases/StreamChunkType.md)
112- [ToolCallState](type-aliases/ToolCallState.md)
113- [ToolResultState](type-aliases/ToolResultState.md)
114​
115## Variables
116​
117- [aiEventClient](variables/aiEventClient.md)
118- [defaultJSONParser](variables/defaultJSONParser.md)
119​
120## Functions
121​
122- [chat](functions/chat.md)
123- [combineStrategies](functions/combineStrategies.md)
124- [convertMessagesToModelMessages](functions/convertMessagesToModelMessages.md)
125- [convertZodToJsonSchema](functions/convertZodToJsonSchema.md)
126- [createChatOptions](functions/createChatOptions.md)
127- [createImageOptions](functions/createImageOptions.md)
128- [createReplayStream](functions/createReplayStream.md)
129- [createSpeechOptions](functions/createSpeechOptions.md)
130- [createSummarizeOptions](functions/createSummarizeOptions.md)
131- [createTranscriptionOptions](functions/createTranscriptionOptions.md)
132- [createVideoOptions](functions/createVideoOptions.md)
133- [generateImage](functions/generateImage.md)
134- [generateMessageId](functions/generateMessageId.md)
135- [generateSpeech](functions/generateSpeech.md)
136- [generateTranscription](functions/generateTranscription.md)
137- [generateVideo](functions/generateVideo.md)
138- [getVideoJobStatus](functions/getVideoJobStatus.md)
139- [maxIterations](functions/maxIterations.md)
140- [modelMessagesToUIMessages](functions/modelMessagesToUIMessages.md)
141- [modelMessageToUIMessage](functions/modelMessageToUIMessage.md)
142- [normalizeToUIMessage](functions/normalizeToUIMessage.md)
143- [parsePartialJSON](functions/parsePartialJSON.md)
144- [streamToText](functions/streamToText.md)
145- [summarize](functions/summarize.md)
146- [toHttpStream](functions/toHttpStream.md)
147- [toolDefinition](functions/toolDefinition.md)
148- [toServerSentEventsStream](functions/toServerSentEventsStream.md)
149- [~~toStreamResponse~~](functions/toStreamResponse.md)
150- [uiMessageToModelMessages](functions/uiMessageToModelMessages.md)
151- [untilFinishReason](functions/untilFinishReason.md)