0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces
github-actions[bot] 273a212bcc
docs: regenerate API documentation (#1265)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
History 2026-08-31 18:34:13 +02:00
..
AbortInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
AfterToolCallInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
AgentLoopState.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ApprovalRequestedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ApprovalRequestedPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ApprovalResolvedPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ArtifactCreatedPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
AudioAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
AudioGenerationOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
AudioGenerationResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
AudioPart.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
AudioVisualization.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
BaseAGUIEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
BaseUsageInput.md docs: regenerate API documentation (#847) 2026-06-25 18:23:45 +02:00
BatchInterruptError.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
CapabilityContext.md docs: regenerate API documentation (#847) 2026-06-25 18:23:45 +02:00
CapabilityGetter.md docs: regenerate API documentation (#847) 2026-06-25 18:23:45 +02:00
ChatMCPOptions.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ChatMiddleware.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ChatMiddlewareConfig.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ChatMiddlewareContext.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ChatResumeToolState.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ChatSandboxHooks.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
ChunkRecording.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ChunkStrategy.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ClientTool.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
CodeModeConsoleEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeExecutionStartedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeExternalCallEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeExternalErrorEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeExternalResultEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeSnippetCallEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeSnippetErrorEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
CodeModeSnippetResultEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ContentPartDataSource.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
ContentPartUrlSource.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
CustomEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
DebugCategories.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
DebugConfig.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
DefaultMessageMetadataByModality.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
DefinedChatMiddleware.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
DocumentPart.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
Embedding.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
EmbeddingAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
EmbeddingOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
EmbeddingResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ErrorInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ExtendedModelDef.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
FileChangedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
FileChangedPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
FinishInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
GenerationAbortInfo.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationErrorInfo.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationFinishInfo.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationMiddleware.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationMiddlewareContext.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationResultTransformContext.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenerationUsageInfo.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
GenericInterruptContinuation.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
ImageAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ImageGenerationOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ImageGenerationResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ImagePart.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
InternalToolCallState.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
InterruptBindingDescriptor.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
InterruptCorrelation.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
InterruptDefinition.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
InterruptDefinitionOptions.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
InterruptResolutionCollection.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
ItemInterruptError.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
IterationInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
JSONParser.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
JSONSchema.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
LazyToolsConfig.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
Logger.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
MCPToolSource.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
MediaInputMetadata.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
MemoryStreamInit.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
MemoryStreamOptions.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
MessagesSnapshotEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
MetadataStore.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ModelCapabilities.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ModelMessage.md fix(ai): preserve AG-UI fields across conversions (#1204) 2026-08-25 13:29:09 +00:00
NormalizedApprovalSchema.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
NormalizedSchemaInput.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
NormalizedSystemPrompt.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
PendingInterruptResumeRecord.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
PersistedArtifactRef.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
PortOpenedPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ProcessorResult.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ProcessorState.md docs: regenerate API documentation (#847) 2026-06-25 18:23:45 +02:00
ProcessOutputPayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ProviderExecutedToolMetadata.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
ProviderTool.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RealtimeAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeAudioPart.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeConnection.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeError.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeEventPayloads.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeImagePart.md docs: regenerate API documentation (#953) 2026-07-16 14:02:20 +02:00
RealtimeMessage.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeSessionConfig.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
RealtimeTextPart.md docs: regenerate API documentation (#953) 2026-07-16 14:02:20 +02:00
RealtimeToken.md docs: regenerate API documentation (#953) 2026-07-16 14:02:20 +02:00
RealtimeTokenAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeTokenOptions.md docs: regenerate API documentation (#953) 2026-07-16 14:02:20 +02:00
RealtimeToolCallPart.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeToolConfig.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RealtimeToolResultPart.md docs: regenerate API documentation (#953) 2026-07-16 14:02:20 +02:00
ReasoningEncryptedValueEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ReasoningEndEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ReasoningMessageContentEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ReasoningMessageEndEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ReasoningMessageStartEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ReasoningStartEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RerankAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RerankAdapterResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RerankOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RerankResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ResolvedEmbeddingItem.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ResolvedMediaPrompt.md docs: regenerate API documentation (#847) 2026-06-25 18:23:45 +02:00
ResponseFormat.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RunDriverOptions.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
RunError.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RunErrorEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RunFinishedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RunRecord.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
RunStartedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
RunStore.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
SandboxFileCustomEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SandboxFileDiffEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SandboxFileEvent.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
SandboxFileHookEvent.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
SandboxLifecyclePayload.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
Scope.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ServerTool.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SessionIdEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SkillLimitErrorInit.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SnippetRegisteredEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SpecTokenUsage.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
StateDeltaEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StateSnapshotEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StepFinishedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StepStartedEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StreamDurability.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
StreamProcessorEvents.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StreamProcessorOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StructuredOutputCompleteEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StructuredOutputMiddlewareConfig.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
StructuredOutputPart.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
StructuredOutputStartEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SummarizationOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SummarizationResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
SummarizeAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
TanStackMessageMetadata.md fix(ai): preserve AG-UI fields across conversions (#1204) 2026-08-25 13:29:09 +00:00
TanStackRunMetadata.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextAdapter.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
TextCompletionChunk.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextMessageContentEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextMessageEndEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextMessageStartEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TextPart.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ThinkingPart.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
Tool.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolCall.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
ToolCallArgsEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolCallEndEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolCallHookContext.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ToolCallPart.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolCallResultEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolCallStartEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolConfig.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolDefinition.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolDefinitionInstance.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolInputAvailableEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
ToolPhaseCompleteInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
ToolRegistry.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ToolResultPart.md fix(ai): preserve AG-UI fields across conversions (#1204) 2026-08-25 13:29:09 +00:00
TranscriptionAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
TranscriptionOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TranscriptionResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TranscriptionSegment.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TranscriptionWord.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TTSAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
TTSOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
TTSResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
UIMessage.md fix(ai): preserve AG-UI fields across conversions (#1204) 2026-08-25 13:29:09 +00:00
UIResourceEvent.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
UIResourcePart.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
UpsertableStreamDurability.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
UsageInfo.md docs: regenerate API documentation (#1265) 2026-08-31 18:34:13 +02:00
VADConfig.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
ValidatedInterruptResumeBatch.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
ValidateInterruptResumeBatchInput.md docs: regenerate API documentation (#1188) 2026-08-21 21:20:02 +00:00
VideoAdapter.md docs: regenerate API documentation (#1141) 2026-08-18 19:53:35 +02:00
VideoGenerationOptions.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
VideoJobResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
VideoPart.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
VideoStatusResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
VideoUrlResult.md docs: regenerate API documentation (#1260) 2026-08-28 11:42:19 +02:00
WebSocketLike.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
WebSocketStreamInit.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00
WsRunContext.md docs: regenerate API documentation (#1195) 2026-08-22 08:16:20 +00:00