From 222d61e09c9cecdf03ab7bc46c3533c0fb827be0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 27 Aug 2026 18:01:44 +0000 Subject: [PATCH] docs: regenerate API documentation --- docs/reference/classes/SkillLimitError.md | 98 +++++++++++++++++++ docs/reference/classes/StreamProcessor.md | 44 ++++----- docs/reference/functions/chat.md | 2 +- .../convertMessagesToModelMessages.md | 2 +- docs/reference/functions/createChatOptions.md | 2 +- .../reference/functions/createReplayStream.md | 2 +- docs/reference/functions/generateMessageId.md | 2 +- .../functions/modelMessageToUIMessage.md | 2 +- .../functions/modelMessagesToUIMessages.md | 2 +- .../functions/normalizeToUIMessage.md | 2 +- .../functions/uiMessageToModelMessages.md | 2 +- docs/reference/functions/uiMessagesToWire.md | 2 +- docs/reference/index.md | 2 + docs/reference/interfaces/AgentLoopState.md | 12 +-- .../interfaces/ApprovalRequestedEvent.md | 10 +- .../interfaces/AudioGenerationOptions.md | 14 +-- .../interfaces/AudioGenerationResult.md | 12 +-- docs/reference/interfaces/BaseAGUIEvent.md | 4 +- .../interfaces/CodeModeConsoleEvent.md | 10 +- .../CodeModeExecutionStartedEvent.md | 10 +- .../interfaces/CodeModeExternalCallEvent.md | 10 +- .../interfaces/CodeModeExternalErrorEvent.md | 10 +- .../interfaces/CodeModeExternalResultEvent.md | 10 +- .../interfaces/CodeModeSnippetCallEvent.md | 10 +- .../interfaces/CodeModeSnippetErrorEvent.md | 10 +- .../interfaces/CodeModeSnippetResultEvent.md | 10 +- docs/reference/interfaces/CustomEvent.md | 6 +- .../DefaultMessageMetadataByModality.md | 12 +-- docs/reference/interfaces/Embedding.md | 6 +- docs/reference/interfaces/EmbeddingOptions.md | 12 +-- docs/reference/interfaces/EmbeddingResult.md | 10 +- docs/reference/interfaces/FileChangedEvent.md | 10 +- .../interfaces/ImageGenerationOptions.md | 16 +-- .../interfaces/ImageGenerationResult.md | 12 +-- docs/reference/interfaces/LazyToolsConfig.md | 4 +- .../interfaces/MediaInputMetadata.md | 6 +- .../interfaces/MessagesSnapshotEvent.md | 2 +- .../interfaces/PersistedArtifactRef.md | 24 ++--- docs/reference/interfaces/ProviderTool.md | 16 +-- .../ReasoningEncryptedValueEvent.md | 2 +- .../reference/interfaces/ReasoningEndEvent.md | 2 +- .../ReasoningMessageContentEvent.md | 2 +- .../interfaces/ReasoningMessageEndEvent.md | 2 +- .../interfaces/ReasoningMessageStartEvent.md | 2 +- .../interfaces/ReasoningStartEvent.md | 2 +- .../interfaces/RerankAdapterResult.md | 8 +- docs/reference/interfaces/RerankOptions.md | 16 +-- docs/reference/interfaces/RerankResult.md | 12 +-- docs/reference/interfaces/ResponseFormat.md | 8 +- docs/reference/interfaces/RunErrorEvent.md | 16 +-- docs/reference/interfaces/RunFinishedEvent.md | 12 +-- docs/reference/interfaces/RunStartedEvent.md | 2 +- .../interfaces/SandboxFileCustomEvent.md | 10 +- .../interfaces/SandboxFileDiffEvent.md | 10 +- docs/reference/interfaces/ServerTool.md | 10 +- docs/reference/interfaces/SessionIdEvent.md | 10 +- .../interfaces/SkillLimitErrorInit.md | 77 +++++++++++++++ .../interfaces/SnippetRegisteredEvent.md | 10 +- docs/reference/interfaces/StateDeltaEvent.md | 2 +- .../interfaces/StateSnapshotEvent.md | 2 +- .../reference/interfaces/StepFinishedEvent.md | 2 +- docs/reference/interfaces/StepStartedEvent.md | 2 +- .../interfaces/StreamProcessorEvents.md | 24 ++--- .../interfaces/StreamProcessorOptions.md | 12 +-- .../StructuredOutputCompleteEvent.md | 10 +- .../interfaces/StructuredOutputPart.md | 16 +-- .../interfaces/StructuredOutputStartEvent.md | 10 +- .../interfaces/SummarizationOptions.md | 22 ++--- .../interfaces/SummarizationResult.md | 10 +- docs/reference/interfaces/TTSOptions.md | 18 ++-- docs/reference/interfaces/TTSResult.md | 18 ++-- .../interfaces/TanStackRunMetadata.md | 22 ++--- .../interfaces/TextCompletionChunk.md | 14 +-- .../interfaces/TextMessageContentEvent.md | 2 +- .../interfaces/TextMessageEndEvent.md | 2 +- .../interfaces/TextMessageStartEvent.md | 2 +- docs/reference/interfaces/TextOptions.md | 44 ++++----- docs/reference/interfaces/TextPart.md | 8 +- docs/reference/interfaces/ThinkingPart.md | 10 +- docs/reference/interfaces/Tool.md | 18 ++-- .../reference/interfaces/ToolCallArgsEvent.md | 2 +- docs/reference/interfaces/ToolCallEndEvent.md | 8 +- docs/reference/interfaces/ToolCallPart.md | 20 ++-- .../interfaces/ToolCallResultEvent.md | 2 +- .../interfaces/ToolCallStartEvent.md | 8 +- docs/reference/interfaces/ToolConfig.md | 2 +- docs/reference/interfaces/ToolDefinition.md | 10 +- .../interfaces/ToolDefinitionInstance.md | 10 +- .../interfaces/ToolInputAvailableEvent.md | 10 +- .../interfaces/TranscriptionOptions.md | 18 ++-- .../interfaces/TranscriptionResult.md | 20 ++-- .../interfaces/TranscriptionSegment.md | 14 +-- .../reference/interfaces/TranscriptionWord.md | 8 +- docs/reference/interfaces/UIResourceEvent.md | 10 +- docs/reference/interfaces/UIResourcePart.md | 14 +-- .../interfaces/VideoGenerationOptions.md | 16 +-- docs/reference/interfaces/VideoJobResult.md | 8 +- .../reference/interfaces/VideoStatusResult.md | 10 +- docs/reference/interfaces/VideoUrlResult.md | 12 +-- docs/reference/type-aliases/AGUIEvent.md | 2 +- docs/reference/type-aliases/AGUIEventType.md | 2 +- .../type-aliases/AgentLoopStrategy.md | 2 +- docs/reference/type-aliases/AnyTool.md | 2 +- docs/reference/type-aliases/ChatStream.md | 2 +- .../type-aliases/ConstrainedModelMessage.md | 2 +- docs/reference/type-aliases/DeepPartial.md | 2 +- .../type-aliases/EmbeddingContentParts.md | 2 +- .../type-aliases/EmbeddingInputItem.md | 2 +- .../type-aliases/EmbeddingInputItemFor.md | 2 +- .../type-aliases/EmbeddingModality.md | 2 +- .../EmbeddingModelInputModalitiesByName.md | 2 +- docs/reference/type-aliases/GeneratedAudio.md | 2 +- docs/reference/type-aliases/GeneratedImage.md | 2 +- .../type-aliases/GeneratedMediaSource.md | 2 +- .../type-aliases/InputModalitiesTypes.md | 6 +- docs/reference/type-aliases/Interrupt.md | 2 +- .../type-aliases/KnownCustomEvent.md | 2 +- docs/reference/type-aliases/MediaInputRole.md | 2 +- docs/reference/type-aliases/MediaPrompt.md | 2 +- docs/reference/type-aliases/MediaPromptFor.md | 2 +- .../type-aliases/MediaPromptModality.md | 2 +- .../reference/type-aliases/MediaPromptPart.md | 2 +- docs/reference/type-aliases/MessagePart.md | 2 +- .../ModelInputModalitiesByName.md | 2 +- .../type-aliases/PersistedArtifactActivity.md | 2 +- .../type-aliases/PersistedArtifactRole.md | 2 +- .../type-aliases/RunAgentResumeItem.md | 2 +- .../type-aliases/RunFinishedOutcome.md | 2 +- docs/reference/type-aliases/StreamChunk.md | 2 +- .../reference/type-aliases/StreamChunkType.md | 2 +- .../type-aliases/StructuredOutputStream.md | 2 +- .../type-aliases/TaggedCustomEvent.md | 2 +- .../type-aliases/ToolExecuteFunction.md | 2 +- .../type-aliases/ToolExecutionContext.md | 2 +- .../TranscriptionResponseFormat.md | 2 +- docs/reference/type-aliases/UsageTotals.md | 2 +- docs/reference/type-aliases/WireMessage.md | 4 +- 137 files changed, 688 insertions(+), 511 deletions(-) create mode 100644 docs/reference/classes/SkillLimitError.md create mode 100644 docs/reference/interfaces/SkillLimitErrorInit.md diff --git a/docs/reference/classes/SkillLimitError.md b/docs/reference/classes/SkillLimitError.md new file mode 100644 index 0000000000..d06897ea88 --- /dev/null +++ b/docs/reference/classes/SkillLimitError.md @@ -0,0 +1,98 @@ +--- +id: SkillLimitError +title: SkillLimitError +--- + +# Class: SkillLimitError + +Defined in: [packages/ai/src/utilities/errors.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L22) + +## Extends + +- `Error` + +## Constructors + +### Constructor + +```ts +new SkillLimitError(init): SkillLimitError; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L30) + +#### Parameters + +##### init + +[`SkillLimitErrorInit`](../interfaces/SkillLimitErrorInit.md) + +#### Returns + +`SkillLimitError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### actual + +```ts +readonly actual: number; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L27) + +*** + +### allowed + +```ts +readonly allowed: number; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L26) + +*** + +### limit + +```ts +readonly limit: string; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L25) + +*** + +### offending + +```ts +readonly offending: string[]; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L28) + +*** + +### path + +```ts +readonly path: "native" | "portable"; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L24) + +*** + +### provider + +```ts +readonly provider: "anthropic" | "openai" | "gemini" | "other"; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L23) diff --git a/docs/reference/classes/StreamProcessor.md b/docs/reference/classes/StreamProcessor.md index f04c34c22f..89901f4a2c 100644 --- a/docs/reference/classes/StreamProcessor.md +++ b/docs/reference/classes/StreamProcessor.md @@ -5,7 +5,7 @@ title: StreamProcessor # Class: StreamProcessor -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:182](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L182) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:183](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L183) StreamProcessor - State machine for processing AI response streams @@ -32,7 +32,7 @@ State tracking: new StreamProcessor(options?): StreamProcessor; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:219](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L219) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:221](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L221) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:219](https://gi addToolApprovalResponse(approvalId, approved): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:383](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L383) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:385](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L385) Add an approval response (called by client after handling onApprovalRequest) @@ -81,7 +81,7 @@ addToolResult( error?): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:339](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L339) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:341](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L341) Add a tool result (called by client after handling onToolCall) @@ -114,7 +114,7 @@ addUserMessage( metadata?): UIMessage; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:267](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L267) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L269) Add a user message to the conversation. Supports both simple string content and multimodal content arrays. @@ -169,7 +169,7 @@ processor.addUserMessage('Hello!', 'custom-id-123') areAllToolsComplete(): boolean; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:414](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L414) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:416](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L416) Check if all tool calls in the last assistant message are complete Useful for auto-continue logic @@ -186,7 +186,7 @@ Useful for auto-continue logic clearMessages(): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:486](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L486) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:488](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L488) Clear all messages @@ -202,7 +202,7 @@ Clear all messages finalizeStream(): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2337](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2337) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2388](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2388) Finalize the stream — complete all pending operations. @@ -226,7 +226,7 @@ docs/chat-architecture.md#single-shot-text-response — Finalization step getCurrentAssistantMessageId(): string | null; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:323](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L323) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:325](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L325) Get the current assistant message ID (if one has been created). Returns null if prepareAssistantMessage() was called but no content @@ -244,7 +244,7 @@ has arrived yet. getMessages(): UIMessage[]; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:406](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L406) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:408](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L408) Get current messages @@ -260,7 +260,7 @@ Get current messages getRecording(): ChunkRecording | null; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2501](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2501) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2554](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2554) Get the current recording @@ -276,7 +276,7 @@ Get the current recording getState(): ProcessorState; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2458](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2458) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2511](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2511) Get current processor state (aggregated across all messages) @@ -292,7 +292,7 @@ Get current processor state (aggregated across all messages) prepareAssistantMessage(): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:302](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L302) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:304](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L304) Prepare for a new assistant message stream. Does NOT create the message immediately -- the message is created lazily @@ -312,7 +312,7 @@ auto-continuation produces no content. process(stream): Promise; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:504](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L504) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:506](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L506) Process a stream and emit events through handlers @@ -334,7 +334,7 @@ Process a stream and emit events through handlers processChunk(chunk): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:538](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L538) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:540](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L540) Process a single chunk from the stream. @@ -364,7 +364,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering removeMessagesAfter(index): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:454](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L454) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:456](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L456) Remove messages after a certain index (for reload/retry) @@ -386,7 +386,7 @@ Remove messages after a certain index (for reload/retry) reset(): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2526](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2526) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2580](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2580) Full reset (including messages) @@ -402,7 +402,7 @@ Full reset (including messages) setMessages(messages): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:238](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L238) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:240](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L240) Set the messages array (e.g., from persisted state) @@ -424,7 +424,7 @@ Set the messages array (e.g., from persisted state) startAssistantMessage(messageId?): string; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:311](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L311) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:313](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L313) #### Parameters @@ -449,7 +449,7 @@ an assistant message which can cause empty message flicker. startRecording(): void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2488](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2488) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2541](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2541) Start recording chunks @@ -468,7 +468,7 @@ toModelMessages(): ModelMessage< | null>[]; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:395](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L395) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:397](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L397) Get the conversation as ModelMessages (for sending to LLM) @@ -487,7 +487,7 @@ Get the conversation as ModelMessages (for sending to LLM) static replay(recording, options?): Promise; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2545](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2545) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2599](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2599) Replay a recording through the processor diff --git a/docs/reference/functions/chat.md b/docs/reference/functions/chat.md index b756c135ce..9b7e5e7e77 100644 --- a/docs/reference/functions/chat.md +++ b/docs/reference/functions/chat.md @@ -9,7 +9,7 @@ title: chat function chat(options): TextActivityResult; ``` -Defined in: [packages/ai/src/activities/chat/index.ts:4549](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4549) +Defined in: [packages/ai/src/activities/chat/index.ts:4548](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4548) Text activity - handles agentic text generation, one-shot text generation, and agentic structured output. diff --git a/docs/reference/functions/convertMessagesToModelMessages.md b/docs/reference/functions/convertMessagesToModelMessages.md index 39b177aa63..4394ff5171 100644 --- a/docs/reference/functions/convertMessagesToModelMessages.md +++ b/docs/reference/functions/convertMessagesToModelMessages.md @@ -12,7 +12,7 @@ function convertMessagesToModelMessages(messages): ModelMessage< | null>[]; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L118) +Defined in: [packages/ai/src/activities/chat/messages.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L136) Convert UIMessages or ModelMessages to ModelMessages diff --git a/docs/reference/functions/createChatOptions.md b/docs/reference/functions/createChatOptions.md index 4825732862..01388ec7bd 100644 --- a/docs/reference/functions/createChatOptions.md +++ b/docs/reference/functions/createChatOptions.md @@ -9,7 +9,7 @@ title: createChatOptions function createChatOptions(options): Omit>, "middleware" | "tools" | "interrupts"> & object; ``` -Defined in: [packages/ai/src/activities/chat/index.ts:595](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L595) +Defined in: [packages/ai/src/activities/chat/index.ts:594](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L594) Create typed options for the chat() function without executing. This is useful for pre-defining configurations with full type inference. diff --git a/docs/reference/functions/createReplayStream.md b/docs/reference/functions/createReplayStream.md index bfa4bc271d..f8cf3f5e64 100644 --- a/docs/reference/functions/createReplayStream.md +++ b/docs/reference/functions/createReplayStream.md @@ -9,7 +9,7 @@ title: createReplayStream function createReplayStream(recording): AsyncIterable; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2557](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2557) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:2611](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L2611) Create an async iterable from a recording diff --git a/docs/reference/functions/generateMessageId.md b/docs/reference/functions/generateMessageId.md index fd36407362..2c1725e6aa 100644 --- a/docs/reference/functions/generateMessageId.md +++ b/docs/reference/functions/generateMessageId.md @@ -9,7 +9,7 @@ title: generateMessageId function generateMessageId(): string; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:854](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L854) +Defined in: [packages/ai/src/activities/chat/messages.ts:1137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1137) Generate a unique message ID diff --git a/docs/reference/functions/modelMessageToUIMessage.md b/docs/reference/functions/modelMessageToUIMessage.md index 8e6c609a64..70ff3e9a66 100644 --- a/docs/reference/functions/modelMessageToUIMessage.md +++ b/docs/reference/functions/modelMessageToUIMessage.md @@ -9,7 +9,7 @@ title: modelMessageToUIMessage function modelMessageToUIMessage(modelMessage, id?): UIMessage; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:534](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L534) +Defined in: [packages/ai/src/activities/chat/messages.ts:706](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L706) Convert a ModelMessage to UIMessage diff --git a/docs/reference/functions/modelMessagesToUIMessages.md b/docs/reference/functions/modelMessagesToUIMessages.md index 393881f275..d2e68fa9b1 100644 --- a/docs/reference/functions/modelMessagesToUIMessages.md +++ b/docs/reference/functions/modelMessagesToUIMessages.md @@ -9,7 +9,7 @@ title: modelMessagesToUIMessages function modelMessagesToUIMessages(modelMessages): UIMessage[]; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:769](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L769) +Defined in: [packages/ai/src/activities/chat/messages.ts:1041](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1041) Convert an array of ModelMessages to UIMessages diff --git a/docs/reference/functions/normalizeToUIMessage.md b/docs/reference/functions/normalizeToUIMessage.md index 8c5e1cc0e2..2fdd041598 100644 --- a/docs/reference/functions/normalizeToUIMessage.md +++ b/docs/reference/functions/normalizeToUIMessage.md @@ -9,7 +9,7 @@ title: normalizeToUIMessage function normalizeToUIMessage(message, generateId): UIMessage; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:831](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L831) +Defined in: [packages/ai/src/activities/chat/messages.ts:1112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1112) Normalize a message (UIMessage or ModelMessage) to a UIMessage Ensures the message has an ID and createdAt timestamp diff --git a/docs/reference/functions/uiMessageToModelMessages.md b/docs/reference/functions/uiMessageToModelMessages.md index ce59332ed0..a5b8299649 100644 --- a/docs/reference/functions/uiMessageToModelMessages.md +++ b/docs/reference/functions/uiMessageToModelMessages.md @@ -12,7 +12,7 @@ function uiMessageToModelMessages(uiMessage): ModelMessage< | null>[]; ``` -Defined in: [packages/ai/src/activities/chat/messages.ts:250](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L250) +Defined in: [packages/ai/src/activities/chat/messages.ts:425](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L425) Convert a UIMessage to ModelMessage(s) diff --git a/docs/reference/functions/uiMessagesToWire.md b/docs/reference/functions/uiMessagesToWire.md index 01a5fa8a88..bd3ec8307a 100644 --- a/docs/reference/functions/uiMessagesToWire.md +++ b/docs/reference/functions/uiMessagesToWire.md @@ -9,7 +9,7 @@ title: uiMessagesToWire function uiMessagesToWire(messages, options?): WireMessage[]; ``` -Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L88) +Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L81) Serialize TanStack `UIMessage`s and `ModelMessage`s into the AG-UI `RunAgentInput.messages` wire shape. Anchors are spec-only (`id`, `role`, diff --git a/docs/reference/index.md b/docs/reference/index.md index e1676b33e8..1b9f2af720 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -18,6 +18,7 @@ title: "@tanstack/ai" - [MCPDuplicateToolNameError](classes/MCPDuplicateToolNameError.md) - [PartialJSONParser](classes/PartialJSONParser.md) - [PunctuationStrategy](classes/PunctuationStrategy.md) +- [SkillLimitError](classes/SkillLimitError.md) - [StandardSchemaValidationError](classes/StandardSchemaValidationError.md) - [StreamProcessor](classes/StreamProcessor.md) - [ToolCallManager](classes/ToolCallManager.md) @@ -161,6 +162,7 @@ title: "@tanstack/ai" - [Scope](interfaces/Scope.md) - [ServerTool](interfaces/ServerTool.md) - [SessionIdEvent](interfaces/SessionIdEvent.md) +- [SkillLimitErrorInit](interfaces/SkillLimitErrorInit.md) - [SnippetRegisteredEvent](interfaces/SnippetRegisteredEvent.md) - [SpecTokenUsage](interfaces/SpecTokenUsage.md) - [StateDeltaEvent](interfaces/StateDeltaEvent.md) diff --git a/docs/reference/interfaces/AgentLoopState.md b/docs/reference/interfaces/AgentLoopState.md index 9464fe7210..568f0a74f3 100644 --- a/docs/reference/interfaces/AgentLoopState.md +++ b/docs/reference/interfaces/AgentLoopState.md @@ -5,7 +5,7 @@ title: AgentLoopState # Interface: AgentLoopState -Defined in: [packages/ai/src/types.ts:911](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L911) +Defined in: [packages/ai/src/types.ts:929](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L929) State passed to agent loop strategy for determining whether to continue @@ -17,7 +17,7 @@ State passed to agent loop strategy for determining whether to continue finishReason: string | null; ``` -Defined in: [packages/ai/src/types.ts:917](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L917) +Defined in: [packages/ai/src/types.ts:935](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L935) Finish reason from the last response @@ -29,7 +29,7 @@ Finish reason from the last response iterationCount: number; ``` -Defined in: [packages/ai/src/types.ts:913](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L913) +Defined in: [packages/ai/src/types.ts:931](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L931) Current iteration count (0-indexed). One iteration = one model turn. @@ -41,7 +41,7 @@ Current iteration count (0-indexed). One iteration = one model turn. lastTurnToolCallCount: number; ``` -Defined in: [packages/ai/src/types.ts:929](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L929) +Defined in: [packages/ai/src/types.ts:947](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L947) Tool calls in the most recent batch — a live model turn or a pending/resume batch (0 when the last phase produced no tool calls). @@ -57,7 +57,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: [packages/ai/src/types.ts:915](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L915) +Defined in: [packages/ai/src/types.ts:933](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L933) Current messages array @@ -69,7 +69,7 @@ Current messages array toolCallCount: number; ``` -Defined in: [packages/ai/src/types.ts:924](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L924) +Defined in: [packages/ai/src/types.ts:942](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L942) Cumulative tool calls counted so far in this run (model-emitted during the agent loop, including ones skipped by middleware, and pending tools from diff --git a/docs/reference/interfaces/ApprovalRequestedEvent.md b/docs/reference/interfaces/ApprovalRequestedEvent.md index e4f9af2987..2e68f7f1b1 100644 --- a/docs/reference/interfaces/ApprovalRequestedEvent.md +++ b/docs/reference/interfaces/ApprovalRequestedEvent.md @@ -5,7 +5,7 @@ title: ApprovalRequestedEvent # ~~Interface: ApprovalRequestedEvent~~ -Defined in: [packages/ai/src/types.ts:1402](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1402) +Defined in: [packages/ai/src/types.ts:1420](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1420) ## Deprecated @@ -24,7 +24,7 @@ compatibility event remains readable until 1.0. optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "approval-requested"; ``` -Defined in: [packages/ai/src/types.ts:1403](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1403) +Defined in: [packages/ai/src/types.ts:1421](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1421) #### Overrides @@ -54,7 +54,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1404](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1404) +Defined in: [packages/ai/src/types.ts:1422](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1422) #### ~~approval~~ diff --git a/docs/reference/interfaces/AudioGenerationOptions.md b/docs/reference/interfaces/AudioGenerationOptions.md index dcbc9bb688..cf0c6e40c5 100644 --- a/docs/reference/interfaces/AudioGenerationOptions.md +++ b/docs/reference/interfaces/AudioGenerationOptions.md @@ -5,7 +5,7 @@ title: AudioGenerationOptions # Interface: AudioGenerationOptions\ -Defined in: [packages/ai/src/types.ts:2047](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2047) +Defined in: [packages/ai/src/types.ts:2065](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2065) Options for audio generation (music, sound effects, etc.). These are the common options supported across providers. @@ -24,7 +24,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:2069](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2069) +Defined in: [packages/ai/src/types.ts:2087](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2087) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -38,7 +38,7 @@ supported. Request-specific — never store on a global client config. optional duration?: number; ``` -Defined in: [packages/ai/src/types.ts:2055](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2055) +Defined in: [packages/ai/src/types.ts:2073](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2073) Desired duration in seconds @@ -50,7 +50,7 @@ Desired duration in seconds logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:2063](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2063) +Defined in: [packages/ai/src/types.ts:2081](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2081) Internal logger threaded from the generateAudio() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -64,7 +64,7 @@ catch blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:2051](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2051) +Defined in: [packages/ai/src/types.ts:2069](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2069) The model to use for audio generation @@ -76,7 +76,7 @@ The model to use for audio generation optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:2057](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2057) +Defined in: [packages/ai/src/types.ts:2075](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2075) Model-specific options for audio generation @@ -88,6 +88,6 @@ Model-specific options for audio generation prompt: string; ``` -Defined in: [packages/ai/src/types.ts:2053](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2053) +Defined in: [packages/ai/src/types.ts:2071](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2071) Text description of the desired audio diff --git a/docs/reference/interfaces/AudioGenerationResult.md b/docs/reference/interfaces/AudioGenerationResult.md index bb8517e356..c5396e0d19 100644 --- a/docs/reference/interfaces/AudioGenerationResult.md +++ b/docs/reference/interfaces/AudioGenerationResult.md @@ -5,7 +5,7 @@ title: AudioGenerationResult # Interface: AudioGenerationResult -Defined in: [packages/ai/src/types.ts:2085](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2085) +Defined in: [packages/ai/src/types.ts:2103](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2103) Result of audio generation @@ -17,7 +17,7 @@ Result of audio generation optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2095](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2095) +Defined in: [packages/ai/src/types.ts:2113](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2113) Persisted artifact references for generated assets, when available @@ -29,7 +29,7 @@ Persisted artifact references for generated assets, when available audio: GeneratedAudio; ``` -Defined in: [packages/ai/src/types.ts:2091](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2091) +Defined in: [packages/ai/src/types.ts:2109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2109) The generated audio @@ -41,7 +41,7 @@ The generated audio id: string; ``` -Defined in: [packages/ai/src/types.ts:2087](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2087) +Defined in: [packages/ai/src/types.ts:2105](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2105) Unique identifier for the generation @@ -53,7 +53,7 @@ Unique identifier for the generation model: string; ``` -Defined in: [packages/ai/src/types.ts:2089](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2089) +Defined in: [packages/ai/src/types.ts:2107](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2107) Model used for generation @@ -65,6 +65,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2093](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2093) +Defined in: [packages/ai/src/types.ts:2111](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2111) Token usage information (if available) diff --git a/docs/reference/interfaces/BaseAGUIEvent.md b/docs/reference/interfaces/BaseAGUIEvent.md index 617948b9c6..194e1be786 100644 --- a/docs/reference/interfaces/BaseAGUIEvent.md +++ b/docs/reference/interfaces/BaseAGUIEvent.md @@ -5,7 +5,7 @@ title: BaseAGUIEvent # Interface: BaseAGUIEvent -Defined in: [packages/ai/src/types.ts:1136](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1136) +Defined in: [packages/ai/src/types.ts:1154](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1154) Base structure for AG-UI events. Extends @ag-ui/core BaseEvent. TanStack extras ride in `metadata`. @@ -30,4 +30,4 @@ Extends @ag-ui/core BaseEvent. TanStack extras ride in `metadata`. optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1137](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1137) +Defined in: [packages/ai/src/types.ts:1155](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1155) diff --git a/docs/reference/interfaces/CodeModeConsoleEvent.md b/docs/reference/interfaces/CodeModeConsoleEvent.md index 0280800e7b..4b347cd84e 100644 --- a/docs/reference/interfaces/CodeModeConsoleEvent.md +++ b/docs/reference/interfaces/CodeModeConsoleEvent.md @@ -5,7 +5,7 @@ title: CodeModeConsoleEvent # Interface: CodeModeConsoleEvent -Defined in: [packages/ai/src/types.ts:1473](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1473) +Defined in: [packages/ai/src/types.ts:1491](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1491) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:console"; ``` -Defined in: [packages/ai/src/types.ts:1474](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1474) +Defined in: [packages/ai/src/types.ts:1492](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1492) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1475](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1475) +Defined in: [packages/ai/src/types.ts:1493](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1493) #### level diff --git a/docs/reference/interfaces/CodeModeExecutionStartedEvent.md b/docs/reference/interfaces/CodeModeExecutionStartedEvent.md index a05f68014d..3e89f5a842 100644 --- a/docs/reference/interfaces/CodeModeExecutionStartedEvent.md +++ b/docs/reference/interfaces/CodeModeExecutionStartedEvent.md @@ -5,7 +5,7 @@ title: CodeModeExecutionStartedEvent # Interface: CodeModeExecutionStartedEvent -Defined in: [packages/ai/src/types.ts:1469](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1469) +Defined in: [packages/ai/src/types.ts:1487](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1487) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:execution_started"; ``` -Defined in: [packages/ai/src/types.ts:1470](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1470) +Defined in: [packages/ai/src/types.ts:1488](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1488) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1471](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1471) +Defined in: [packages/ai/src/types.ts:1489](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1489) #### codeLength diff --git a/docs/reference/interfaces/CodeModeExternalCallEvent.md b/docs/reference/interfaces/CodeModeExternalCallEvent.md index 2f32adf4f5..75cab3e980 100644 --- a/docs/reference/interfaces/CodeModeExternalCallEvent.md +++ b/docs/reference/interfaces/CodeModeExternalCallEvent.md @@ -5,7 +5,7 @@ title: CodeModeExternalCallEvent # Interface: CodeModeExternalCallEvent -Defined in: [packages/ai/src/types.ts:1481](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1481) +Defined in: [packages/ai/src/types.ts:1499](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1499) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:external_call"; ``` -Defined in: [packages/ai/src/types.ts:1482](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1482) +Defined in: [packages/ai/src/types.ts:1500](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1500) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1483](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1483) +Defined in: [packages/ai/src/types.ts:1501](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1501) #### args diff --git a/docs/reference/interfaces/CodeModeExternalErrorEvent.md b/docs/reference/interfaces/CodeModeExternalErrorEvent.md index 3efd3ae3fc..72d58b9a6a 100644 --- a/docs/reference/interfaces/CodeModeExternalErrorEvent.md +++ b/docs/reference/interfaces/CodeModeExternalErrorEvent.md @@ -5,7 +5,7 @@ title: CodeModeExternalErrorEvent # Interface: CodeModeExternalErrorEvent -Defined in: [packages/ai/src/types.ts:1489](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1489) +Defined in: [packages/ai/src/types.ts:1507](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1507) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:external_error"; ``` -Defined in: [packages/ai/src/types.ts:1490](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1490) +Defined in: [packages/ai/src/types.ts:1508](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1508) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1491](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1491) +Defined in: [packages/ai/src/types.ts:1509](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1509) #### duration diff --git a/docs/reference/interfaces/CodeModeExternalResultEvent.md b/docs/reference/interfaces/CodeModeExternalResultEvent.md index f4368c5269..c695f2746a 100644 --- a/docs/reference/interfaces/CodeModeExternalResultEvent.md +++ b/docs/reference/interfaces/CodeModeExternalResultEvent.md @@ -5,7 +5,7 @@ title: CodeModeExternalResultEvent # Interface: CodeModeExternalResultEvent -Defined in: [packages/ai/src/types.ts:1485](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1485) +Defined in: [packages/ai/src/types.ts:1503](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1503) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:external_result"; ``` -Defined in: [packages/ai/src/types.ts:1486](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1486) +Defined in: [packages/ai/src/types.ts:1504](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1504) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1487](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1487) +Defined in: [packages/ai/src/types.ts:1505](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1505) #### duration diff --git a/docs/reference/interfaces/CodeModeSnippetCallEvent.md b/docs/reference/interfaces/CodeModeSnippetCallEvent.md index 916b9d0c2b..b454a4982a 100644 --- a/docs/reference/interfaces/CodeModeSnippetCallEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetCallEvent.md @@ -5,7 +5,7 @@ title: CodeModeSnippetCallEvent # Interface: CodeModeSnippetCallEvent -Defined in: [packages/ai/src/types.ts:1493](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1493) +Defined in: [packages/ai/src/types.ts:1511](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1511) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:snippet_call"; ``` -Defined in: [packages/ai/src/types.ts:1494](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1494) +Defined in: [packages/ai/src/types.ts:1512](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1512) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1495](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1495) +Defined in: [packages/ai/src/types.ts:1513](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1513) #### input diff --git a/docs/reference/interfaces/CodeModeSnippetErrorEvent.md b/docs/reference/interfaces/CodeModeSnippetErrorEvent.md index 8d4960da75..101c2de9f1 100644 --- a/docs/reference/interfaces/CodeModeSnippetErrorEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetErrorEvent.md @@ -5,7 +5,7 @@ title: CodeModeSnippetErrorEvent # Interface: CodeModeSnippetErrorEvent -Defined in: [packages/ai/src/types.ts:1506](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1506) +Defined in: [packages/ai/src/types.ts:1524](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1524) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:snippet_error"; ``` -Defined in: [packages/ai/src/types.ts:1507](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1507) +Defined in: [packages/ai/src/types.ts:1525](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1525) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1508](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1508) +Defined in: [packages/ai/src/types.ts:1526](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1526) #### duration diff --git a/docs/reference/interfaces/CodeModeSnippetResultEvent.md b/docs/reference/interfaces/CodeModeSnippetResultEvent.md index c460e2d29e..d007dbce23 100644 --- a/docs/reference/interfaces/CodeModeSnippetResultEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetResultEvent.md @@ -5,7 +5,7 @@ title: CodeModeSnippetResultEvent # Interface: CodeModeSnippetResultEvent -Defined in: [packages/ai/src/types.ts:1497](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1497) +Defined in: [packages/ai/src/types.ts:1515](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1515) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "code_mode:snippet_result"; ``` -Defined in: [packages/ai/src/types.ts:1498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1498) +Defined in: [packages/ai/src/types.ts:1516](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1516) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1499](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1499) +Defined in: [packages/ai/src/types.ts:1517](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1517) #### duration diff --git a/docs/reference/interfaces/CustomEvent.md b/docs/reference/interfaces/CustomEvent.md index 933f358fee..c52de95c31 100644 --- a/docs/reference/interfaces/CustomEvent.md +++ b/docs/reference/interfaces/CustomEvent.md @@ -5,7 +5,7 @@ title: CustomEvent # Interface: CustomEvent -Defined in: [packages/ai/src/types.ts:1345](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1345) +Defined in: [packages/ai/src/types.ts:1363](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1363) Custom event for extensibility. @@ -47,7 +47,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) *** @@ -57,4 +57,4 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) diff --git a/docs/reference/interfaces/DefaultMessageMetadataByModality.md b/docs/reference/interfaces/DefaultMessageMetadataByModality.md index dcbf5fbacd..97c866a16a 100644 --- a/docs/reference/interfaces/DefaultMessageMetadataByModality.md +++ b/docs/reference/interfaces/DefaultMessageMetadataByModality.md @@ -5,7 +5,7 @@ title: DefaultMessageMetadataByModality # Interface: DefaultMessageMetadataByModality -Defined in: [packages/ai/src/types.ts:2475](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2475) +Defined in: [packages/ai/src/types.ts:2493](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2493) Default metadata type for adapters that don't define custom metadata. Uses unknown for all modalities. @@ -18,7 +18,7 @@ Uses unknown for all modalities. audio: unknown; ``` -Defined in: [packages/ai/src/types.ts:2478](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2478) +Defined in: [packages/ai/src/types.ts:2496](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2496) *** @@ -28,7 +28,7 @@ Defined in: [packages/ai/src/types.ts:2478](https://github.com/TanStack/ai/blob/ document: unknown; ``` -Defined in: [packages/ai/src/types.ts:2480](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2480) +Defined in: [packages/ai/src/types.ts:2498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2498) *** @@ -38,7 +38,7 @@ Defined in: [packages/ai/src/types.ts:2480](https://github.com/TanStack/ai/blob/ image: unknown; ``` -Defined in: [packages/ai/src/types.ts:2477](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2477) +Defined in: [packages/ai/src/types.ts:2495](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2495) *** @@ -48,7 +48,7 @@ Defined in: [packages/ai/src/types.ts:2477](https://github.com/TanStack/ai/blob/ text: unknown; ``` -Defined in: [packages/ai/src/types.ts:2476](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2476) +Defined in: [packages/ai/src/types.ts:2494](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2494) *** @@ -58,4 +58,4 @@ Defined in: [packages/ai/src/types.ts:2476](https://github.com/TanStack/ai/blob/ video: unknown; ``` -Defined in: [packages/ai/src/types.ts:2479](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2479) +Defined in: [packages/ai/src/types.ts:2497](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2497) diff --git a/docs/reference/interfaces/Embedding.md b/docs/reference/interfaces/Embedding.md index 034a37bb4f..e3ec30ef64 100644 --- a/docs/reference/interfaces/Embedding.md +++ b/docs/reference/interfaces/Embedding.md @@ -5,7 +5,7 @@ title: Embedding # Interface: Embedding -Defined in: [packages/ai/src/types.ts:2450](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2450) +Defined in: [packages/ai/src/types.ts:2468](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2468) A single embedding vector. @@ -17,7 +17,7 @@ A single embedding vector. index: number; ``` -Defined in: [packages/ai/src/types.ts:2454](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2454) +Defined in: [packages/ai/src/types.ts:2472](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2472) Position of the source item in the (normalized) input array @@ -29,6 +29,6 @@ Position of the source item in the (normalized) input array vector: number[]; ``` -Defined in: [packages/ai/src/types.ts:2452](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2452) +Defined in: [packages/ai/src/types.ts:2470](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2470) The embedding vector diff --git a/docs/reference/interfaces/EmbeddingOptions.md b/docs/reference/interfaces/EmbeddingOptions.md index a1fd82639f..7c2e3fc32b 100644 --- a/docs/reference/interfaces/EmbeddingOptions.md +++ b/docs/reference/interfaces/EmbeddingOptions.md @@ -5,7 +5,7 @@ title: EmbeddingOptions # Interface: EmbeddingOptions\ -Defined in: [packages/ai/src/types.ts:2427](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2427) +Defined in: [packages/ai/src/types.ts:2445](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2445) Options for embedding generation, as received by adapters. The `embed()` entry point normalizes a single input item to an array before calling the @@ -25,7 +25,7 @@ adapter, so `input` is always an array here. optional dimensions?: number; ``` -Defined in: [packages/ai/src/types.ts:2436](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2436) +Defined in: [packages/ai/src/types.ts:2454](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2454) Requested output dimensionality. Adapters for models with fixed dimensions throw a clear runtime error when this is set. @@ -38,7 +38,7 @@ dimensions throw a clear runtime error when this is set. input: EmbeddingInputItem[]; ``` -Defined in: [packages/ai/src/types.ts:2431](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2431) +Defined in: [packages/ai/src/types.ts:2449](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2449) The items to embed — one vector per item @@ -50,7 +50,7 @@ The items to embed — one vector per item logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:2444](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2444) +Defined in: [packages/ai/src/types.ts:2462](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2462) Internal logger threaded from the embed() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch @@ -64,7 +64,7 @@ blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:2429](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2429) +Defined in: [packages/ai/src/types.ts:2447](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2447) The model to use for embedding generation @@ -76,6 +76,6 @@ The model to use for embedding generation optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:2438](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2438) +Defined in: [packages/ai/src/types.ts:2456](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2456) Model-specific options for embedding generation diff --git a/docs/reference/interfaces/EmbeddingResult.md b/docs/reference/interfaces/EmbeddingResult.md index de8aee3526..96b5fabd62 100644 --- a/docs/reference/interfaces/EmbeddingResult.md +++ b/docs/reference/interfaces/EmbeddingResult.md @@ -5,7 +5,7 @@ title: EmbeddingResult # Interface: EmbeddingResult -Defined in: [packages/ai/src/types.ts:2460](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2460) +Defined in: [packages/ai/src/types.ts:2478](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2478) Result of embedding generation. @@ -17,7 +17,7 @@ Result of embedding generation. embeddings: Embedding[]; ``` -Defined in: [packages/ai/src/types.ts:2466](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2466) +Defined in: [packages/ai/src/types.ts:2484](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2484) One embedding per input item, in input order @@ -29,7 +29,7 @@ One embedding per input item, in input order id: string; ``` -Defined in: [packages/ai/src/types.ts:2462](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2462) +Defined in: [packages/ai/src/types.ts:2480](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2480) Unique identifier for the generation @@ -41,7 +41,7 @@ Unique identifier for the generation model: string; ``` -Defined in: [packages/ai/src/types.ts:2464](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2464) +Defined in: [packages/ai/src/types.ts:2482](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2482) Model used for generation @@ -53,6 +53,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2468](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2468) +Defined in: [packages/ai/src/types.ts:2486](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2486) Token usage information (if provided by the adapter) diff --git a/docs/reference/interfaces/FileChangedEvent.md b/docs/reference/interfaces/FileChangedEvent.md index cf68293fd9..d976bb9585 100644 --- a/docs/reference/interfaces/FileChangedEvent.md +++ b/docs/reference/interfaces/FileChangedEvent.md @@ -5,7 +5,7 @@ title: FileChangedEvent # Interface: FileChangedEvent -Defined in: [packages/ai/src/types.ts:1459](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1459) +Defined in: [packages/ai/src/types.ts:1477](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1477) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "file.changed"; ``` -Defined in: [packages/ai/src/types.ts:1460](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1460) +Defined in: [packages/ai/src/types.ts:1478](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1478) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1461](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1461) +Defined in: [packages/ai/src/types.ts:1479](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1479) #### diff diff --git a/docs/reference/interfaces/ImageGenerationOptions.md b/docs/reference/interfaces/ImageGenerationOptions.md index a0a8ee88dd..eaa4dca340 100644 --- a/docs/reference/interfaces/ImageGenerationOptions.md +++ b/docs/reference/interfaces/ImageGenerationOptions.md @@ -5,7 +5,7 @@ title: ImageGenerationOptions # Interface: ImageGenerationOptions\ -Defined in: [packages/ai/src/types.ts:1918](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1918) +Defined in: [packages/ai/src/types.ts:1936](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1936) Options for image generation. These are the common options supported across providers. @@ -28,7 +28,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:1950](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1950) +Defined in: [packages/ai/src/types.ts:1968](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1968) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -42,7 +42,7 @@ supported. Request-specific — never store on a global client config. logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:1944](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1944) +Defined in: [packages/ai/src/types.ts:1962](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1962) Internal logger threaded from the generateImage() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks. @@ -55,7 +55,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:1923](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1923) +Defined in: [packages/ai/src/types.ts:1941](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1941) The model to use for image generation @@ -67,7 +67,7 @@ The model to use for image generation optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:1939](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1939) +Defined in: [packages/ai/src/types.ts:1957](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1957) Model-specific options for image generation @@ -79,7 +79,7 @@ Model-specific options for image generation optional numberOfImages?: number; ``` -Defined in: [packages/ai/src/types.ts:1935](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1935) +Defined in: [packages/ai/src/types.ts:1953](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1953) Number of images to generate (default: 1) @@ -91,7 +91,7 @@ Number of images to generate (default: 1) prompt: MediaPrompt; ``` -Defined in: [packages/ai/src/types.ts:1933](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1933) +Defined in: [packages/ai/src/types.ts:1951](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1951) Description of the desired image(s): a plain string, or an ordered array of content parts for image-conditioned generation (image-to-image, @@ -109,6 +109,6 @@ multimodal `contents`, OpenAI `images.edit()`, fal `image_url` / optional size?: TSize; ``` -Defined in: [packages/ai/src/types.ts:1937](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1937) +Defined in: [packages/ai/src/types.ts:1955](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1955) Image size in WIDTHxHEIGHT format (e.g., "1024x1024") diff --git a/docs/reference/interfaces/ImageGenerationResult.md b/docs/reference/interfaces/ImageGenerationResult.md index b0d9324f13..adbce515e2 100644 --- a/docs/reference/interfaces/ImageGenerationResult.md +++ b/docs/reference/interfaces/ImageGenerationResult.md @@ -5,7 +5,7 @@ title: ImageGenerationResult # Interface: ImageGenerationResult -Defined in: [packages/ai/src/types.ts:2026](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2026) +Defined in: [packages/ai/src/types.ts:2044](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2044) Result of image generation @@ -17,7 +17,7 @@ Result of image generation optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2036](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2036) +Defined in: [packages/ai/src/types.ts:2054](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2054) Persisted artifact references for generated assets, when available @@ -29,7 +29,7 @@ Persisted artifact references for generated assets, when available id: string; ``` -Defined in: [packages/ai/src/types.ts:2028](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2028) +Defined in: [packages/ai/src/types.ts:2046](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2046) Unique identifier for the generation @@ -41,7 +41,7 @@ Unique identifier for the generation images: GeneratedImage[]; ``` -Defined in: [packages/ai/src/types.ts:2032](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2032) +Defined in: [packages/ai/src/types.ts:2050](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2050) Array of generated images @@ -53,7 +53,7 @@ Array of generated images model: string; ``` -Defined in: [packages/ai/src/types.ts:2030](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2030) +Defined in: [packages/ai/src/types.ts:2048](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2048) Model used for generation @@ -65,6 +65,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2034](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2034) +Defined in: [packages/ai/src/types.ts:2052](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2052) Token usage information (if available) diff --git a/docs/reference/interfaces/LazyToolsConfig.md b/docs/reference/interfaces/LazyToolsConfig.md index 4037d63de9..c3556431bb 100644 --- a/docs/reference/interfaces/LazyToolsConfig.md +++ b/docs/reference/interfaces/LazyToolsConfig.md @@ -5,7 +5,7 @@ title: LazyToolsConfig # Interface: LazyToolsConfig -Defined in: [packages/ai/src/types.ts:799](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L799) +Defined in: [packages/ai/src/types.ts:817](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L817) Configuration for the lazy-tool discovery catalog, shared by chat() and Code Mode. Optional in both — lazy behavior is triggered purely by tools @@ -21,7 +21,7 @@ always returns the full description + schema. optional includeDescription?: "full" | "first-sentence" | "none"; ``` -Defined in: [packages/ai/src/types.ts:805](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L805) +Defined in: [packages/ai/src/types.ts:823](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L823) How much of each lazy tool's description appears in the pre-discovery catalog (the names list shown before the model discovers the tool). diff --git a/docs/reference/interfaces/MediaInputMetadata.md b/docs/reference/interfaces/MediaInputMetadata.md index 39962c83b4..cfe75da76c 100644 --- a/docs/reference/interfaces/MediaInputMetadata.md +++ b/docs/reference/interfaces/MediaInputMetadata.md @@ -5,7 +5,7 @@ title: MediaInputMetadata # Interface: MediaInputMetadata -Defined in: [packages/ai/src/types.ts:1841](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1841) +Defined in: [packages/ai/src/types.ts:1859](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1859) Metadata convention for image / video / audio inputs to media generation. Carried on `ImagePart.metadata` / `VideoPart.metadata` / `AudioPart.metadata` @@ -19,7 +19,7 @@ when used as conditioning inputs to `generateImage()` or `generateVideo()`. optional role?: MediaInputRole; ``` -Defined in: [packages/ai/src/types.ts:1843](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1843) +Defined in: [packages/ai/src/types.ts:1861](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1861) Optional role hint disambiguating the part's intent for the adapter @@ -31,7 +31,7 @@ Optional role hint disambiguating the part's intent for the adapter optional tag?: string; ``` -Defined in: [packages/ai/src/types.ts:1852](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1852) +Defined in: [packages/ai/src/types.ts:1870](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1870) Optional user-defined label for this input (e.g. `'woman-in-red-dress'`). **Informational only** — adapters never read it and the SDK never diff --git a/docs/reference/interfaces/MessagesSnapshotEvent.md b/docs/reference/interfaces/MessagesSnapshotEvent.md index d7fb3b5b4a..74e46d93ac 100644 --- a/docs/reference/interfaces/MessagesSnapshotEvent.md +++ b/docs/reference/interfaces/MessagesSnapshotEvent.md @@ -5,7 +5,7 @@ title: MessagesSnapshotEvent # Interface: MessagesSnapshotEvent -Defined in: [packages/ai/src/types.ts:1321](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1321) +Defined in: [packages/ai/src/types.ts:1339](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1339) Emitted to provide a snapshot of all messages in a conversation. diff --git a/docs/reference/interfaces/PersistedArtifactRef.md b/docs/reference/interfaces/PersistedArtifactRef.md index 20956c5c1e..c6e59eed31 100644 --- a/docs/reference/interfaces/PersistedArtifactRef.md +++ b/docs/reference/interfaces/PersistedArtifactRef.md @@ -5,7 +5,7 @@ title: PersistedArtifactRef # Interface: PersistedArtifactRef -Defined in: [packages/ai/src/types.ts:1980](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1980) +Defined in: [packages/ai/src/types.ts:1998](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1998) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/ai/src/types.ts:1980](https://github.com/TanStack/ai/blob/ artifactId: string; ``` -Defined in: [packages/ai/src/types.ts:1982](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1982) +Defined in: [packages/ai/src/types.ts:2000](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2000) *** @@ -25,7 +25,7 @@ Defined in: [packages/ai/src/types.ts:1982](https://github.com/TanStack/ai/blob/ createdAt: string; ``` -Defined in: [packages/ai/src/types.ts:1988](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1988) +Defined in: [packages/ai/src/types.ts:2006](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2006) *** @@ -35,7 +35,7 @@ Defined in: [packages/ai/src/types.ts:1988](https://github.com/TanStack/ai/blob/ mimeType: string; ``` -Defined in: [packages/ai/src/types.ts:1986](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1986) +Defined in: [packages/ai/src/types.ts:2004](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2004) *** @@ -45,7 +45,7 @@ Defined in: [packages/ai/src/types.ts:1986](https://github.com/TanStack/ai/blob/ name: string; ``` -Defined in: [packages/ai/src/types.ts:1985](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1985) +Defined in: [packages/ai/src/types.ts:2003](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2003) *** @@ -55,7 +55,7 @@ Defined in: [packages/ai/src/types.ts:1985](https://github.com/TanStack/ai/blob/ role: PersistedArtifactRole; ``` -Defined in: [packages/ai/src/types.ts:1981](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1981) +Defined in: [packages/ai/src/types.ts:1999](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1999) *** @@ -65,7 +65,7 @@ Defined in: [packages/ai/src/types.ts:1981](https://github.com/TanStack/ai/blob/ runId: string; ``` -Defined in: [packages/ai/src/types.ts:1984](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1984) +Defined in: [packages/ai/src/types.ts:2002](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2002) *** @@ -75,7 +75,7 @@ Defined in: [packages/ai/src/types.ts:1984](https://github.com/TanStack/ai/blob/ size: number; ``` -Defined in: [packages/ai/src/types.ts:1987](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1987) +Defined in: [packages/ai/src/types.ts:2005](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2005) *** @@ -85,7 +85,7 @@ Defined in: [packages/ai/src/types.ts:1987](https://github.com/TanStack/ai/blob/ source: object; ``` -Defined in: [packages/ai/src/types.ts:2004](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2004) +Defined in: [packages/ai/src/types.ts:2022](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2022) #### activity @@ -137,7 +137,7 @@ provider: string; optional sourceUrl?: string; ``` -Defined in: [packages/ai/src/types.ts:1995](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1995) +Defined in: [packages/ai/src/types.ts:2013](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2013) Where these bytes were fetched FROM — the provider's original result URL, or a caller-supplied prompt URL when `allowInputUrl` opted that in. Usually @@ -152,7 +152,7 @@ instead. threadId: string; ``` -Defined in: [packages/ai/src/types.ts:1983](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1983) +Defined in: [packages/ai/src/types.ts:2001](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2001) *** @@ -162,7 +162,7 @@ Defined in: [packages/ai/src/types.ts:1983](https://github.com/TanStack/ai/blob/ optional url?: string; ``` -Defined in: [packages/ai/src/types.ts:2003](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2003) +Defined in: [packages/ai/src/types.ts:2021](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2021) Durable app-origin URL that serves this artifact's persisted bytes (your `GET` route around `retrieveArtifact` / `retrieveBlob`). Stamped by diff --git a/docs/reference/interfaces/ProviderTool.md b/docs/reference/interfaces/ProviderTool.md index 27de1271d9..6c4db1d5e0 100644 --- a/docs/reference/interfaces/ProviderTool.md +++ b/docs/reference/interfaces/ProviderTool.md @@ -65,7 +65,7 @@ Defined in: [packages/ai/src/tools/provider-tool.ts:24](https://github.com/TanSt description: string; ``` -Defined in: [packages/ai/src/types.ts:700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L700) +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) Clear description of what the tool does. @@ -90,7 +90,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: (args, context?) => any; ``` -Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) +Defined in: [packages/ai/src/types.ts:798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L798) Optional function to execute when the model calls this tool. @@ -138,7 +138,7 @@ execute: async (args) => { optional inputSchema?: SchemaInput; ``` -Defined in: [packages/ai/src/types.ts:740](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L740) +Defined in: [packages/ai/src/types.ts:758](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L758) Schema describing the tool's input parameters. @@ -196,7 +196,7 @@ type({ optional lazy?: boolean; ``` -Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) +Defined in: [packages/ai/src/types.ts:804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L804) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -212,7 +212,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L789) +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) Additional metadata for adapters or custom extensions @@ -228,7 +228,7 @@ Additional metadata for adapters or custom extensions name: string; ``` -Defined in: [packages/ai/src/types.ts:690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L690) +Defined in: [packages/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L708) Unique name of the tool (used by the model to call it). @@ -253,7 +253,7 @@ Must be unique within the tools array. optional needsApproval?: boolean; ``` -Defined in: [packages/ai/src/types.ts:783](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L783) +Defined in: [packages/ai/src/types.ts:801](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L801) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -269,7 +269,7 @@ If true, tool execution requires user approval before running. Works with both s optional outputSchema?: SchemaInput; ``` -Defined in: [packages/ai/src/types.ts:761](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L761) +Defined in: [packages/ai/src/types.ts:779](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L779) Optional schema for validating tool output. diff --git a/docs/reference/interfaces/ReasoningEncryptedValueEvent.md b/docs/reference/interfaces/ReasoningEncryptedValueEvent.md index fbfd1c1435..f80c562bcf 100644 --- a/docs/reference/interfaces/ReasoningEncryptedValueEvent.md +++ b/docs/reference/interfaces/ReasoningEncryptedValueEvent.md @@ -5,7 +5,7 @@ title: ReasoningEncryptedValueEvent # Interface: ReasoningEncryptedValueEvent -Defined in: [packages/ai/src/types.ts:1632](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1632) +Defined in: [packages/ai/src/types.ts:1650](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1650) Emitted for encrypted reasoning values. diff --git a/docs/reference/interfaces/ReasoningEndEvent.md b/docs/reference/interfaces/ReasoningEndEvent.md index 598f715b24..afd8bac871 100644 --- a/docs/reference/interfaces/ReasoningEndEvent.md +++ b/docs/reference/interfaces/ReasoningEndEvent.md @@ -5,7 +5,7 @@ title: ReasoningEndEvent # Interface: ReasoningEndEvent -Defined in: [packages/ai/src/types.ts:1625](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1625) +Defined in: [packages/ai/src/types.ts:1643](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1643) Emitted when reasoning ends for a message. diff --git a/docs/reference/interfaces/ReasoningMessageContentEvent.md b/docs/reference/interfaces/ReasoningMessageContentEvent.md index b7fb89b537..a156153177 100644 --- a/docs/reference/interfaces/ReasoningMessageContentEvent.md +++ b/docs/reference/interfaces/ReasoningMessageContentEvent.md @@ -5,7 +5,7 @@ title: ReasoningMessageContentEvent # Interface: ReasoningMessageContentEvent -Defined in: [packages/ai/src/types.ts:1611](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1611) +Defined in: [packages/ai/src/types.ts:1629](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1629) Emitted when reasoning message content is generated. diff --git a/docs/reference/interfaces/ReasoningMessageEndEvent.md b/docs/reference/interfaces/ReasoningMessageEndEvent.md index 6274345e86..dba61cb974 100644 --- a/docs/reference/interfaces/ReasoningMessageEndEvent.md +++ b/docs/reference/interfaces/ReasoningMessageEndEvent.md @@ -5,7 +5,7 @@ title: ReasoningMessageEndEvent # Interface: ReasoningMessageEndEvent -Defined in: [packages/ai/src/types.ts:1618](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1618) +Defined in: [packages/ai/src/types.ts:1636](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1636) Emitted when a reasoning message ends. diff --git a/docs/reference/interfaces/ReasoningMessageStartEvent.md b/docs/reference/interfaces/ReasoningMessageStartEvent.md index 290c7f9337..2ea5c72dfd 100644 --- a/docs/reference/interfaces/ReasoningMessageStartEvent.md +++ b/docs/reference/interfaces/ReasoningMessageStartEvent.md @@ -5,7 +5,7 @@ title: ReasoningMessageStartEvent # Interface: ReasoningMessageStartEvent -Defined in: [packages/ai/src/types.ts:1604](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1604) +Defined in: [packages/ai/src/types.ts:1622](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1622) Emitted when a reasoning message starts. diff --git a/docs/reference/interfaces/ReasoningStartEvent.md b/docs/reference/interfaces/ReasoningStartEvent.md index 2611af7b99..9cd0ec5f8f 100644 --- a/docs/reference/interfaces/ReasoningStartEvent.md +++ b/docs/reference/interfaces/ReasoningStartEvent.md @@ -5,7 +5,7 @@ title: ReasoningStartEvent # Interface: ReasoningStartEvent -Defined in: [packages/ai/src/types.ts:1597](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1597) +Defined in: [packages/ai/src/types.ts:1615](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1615) Emitted when reasoning starts for a message. diff --git a/docs/reference/interfaces/RerankAdapterResult.md b/docs/reference/interfaces/RerankAdapterResult.md index df06a1fc37..d9507f321a 100644 --- a/docs/reference/interfaces/RerankAdapterResult.md +++ b/docs/reference/interfaces/RerankAdapterResult.md @@ -5,7 +5,7 @@ title: RerankAdapterResult # Interface: RerankAdapterResult -Defined in: [packages/ai/src/types.ts:1788](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1788) +Defined in: [packages/ai/src/types.ts:1806](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1806) Provider-level rerank result. Adapters return scored indices into the (serialized) `documents` array plus usage — never the documents themselves. @@ -19,7 +19,7 @@ The activity attaches the original documents. id: string; ``` -Defined in: [packages/ai/src/types.ts:1789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1789) +Defined in: [packages/ai/src/types.ts:1807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1807) *** @@ -29,7 +29,7 @@ Defined in: [packages/ai/src/types.ts:1789](https://github.com/TanStack/ai/blob/ ranking: object[]; ``` -Defined in: [packages/ai/src/types.ts:1791](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1791) +Defined in: [packages/ai/src/types.ts:1809](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1809) Scored results, highest relevance first, as indices into `documents`. @@ -53,4 +53,4 @@ score: number; usage: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:1792](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1792) +Defined in: [packages/ai/src/types.ts:1810](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1810) diff --git a/docs/reference/interfaces/RerankOptions.md b/docs/reference/interfaces/RerankOptions.md index 61590f98c4..7410d776f7 100644 --- a/docs/reference/interfaces/RerankOptions.md +++ b/docs/reference/interfaces/RerankOptions.md @@ -5,7 +5,7 @@ title: RerankOptions # Interface: RerankOptions\ -Defined in: [packages/ai/src/types.ts:1761](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1761) +Defined in: [packages/ai/src/types.ts:1779](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1779) Options passed to a [RerankAdapter](RerankAdapter.md). Documents reach the adapter already serialized to strings — the `rerank()` activity stringifies object @@ -26,7 +26,7 @@ deal with the caller's document type. optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:1774](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1774) +Defined in: [packages/ai/src/types.ts:1792](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1792) Forwarded to the provider request for cancellation. @@ -38,7 +38,7 @@ Forwarded to the provider request for cancellation. documents: string[]; ``` -Defined in: [packages/ai/src/types.ts:1768](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1768) +Defined in: [packages/ai/src/types.ts:1786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1786) Documents to rerank, pre-serialized to strings by the activity. @@ -50,7 +50,7 @@ Documents to rerank, pre-serialized to strings by the activity. logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:1780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1780) +Defined in: [packages/ai/src/types.ts:1798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1798) Internal logger threaded from the rerank() entry point. Adapters must call logger.request() before the provider call and logger.errors() in catch @@ -64,7 +64,7 @@ blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:1764](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1764) +Defined in: [packages/ai/src/types.ts:1782](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1782) *** @@ -74,7 +74,7 @@ Defined in: [packages/ai/src/types.ts:1764](https://github.com/TanStack/ai/blob/ optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:1772](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1772) +Defined in: [packages/ai/src/types.ts:1790](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1790) Provider-specific options forwarded by the rerank() activity. @@ -86,7 +86,7 @@ Provider-specific options forwarded by the rerank() activity. query: string; ``` -Defined in: [packages/ai/src/types.ts:1766](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1766) +Defined in: [packages/ai/src/types.ts:1784](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1784) The search query documents are scored against. @@ -98,6 +98,6 @@ The search query documents are scored against. optional topN?: number; ``` -Defined in: [packages/ai/src/types.ts:1770](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1770) +Defined in: [packages/ai/src/types.ts:1788](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1788) Return only the top N results. Passed through to the provider. diff --git a/docs/reference/interfaces/RerankResult.md b/docs/reference/interfaces/RerankResult.md index 4f7459697b..f660c04223 100644 --- a/docs/reference/interfaces/RerankResult.md +++ b/docs/reference/interfaces/RerankResult.md @@ -5,7 +5,7 @@ title: RerankResult # Interface: RerankResult\ -Defined in: [packages/ai/src/types.ts:1800](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1800) +Defined in: [packages/ai/src/types.ts:1818](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1818) Public result of the `rerank()` activity, generic over the caller's document element type so `document` / `rerankedDocuments` carry the original values @@ -25,7 +25,7 @@ element type so `document` / `rerankedDocuments` carry the original values id: string; ``` -Defined in: [packages/ai/src/types.ts:1801](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1801) +Defined in: [packages/ai/src/types.ts:1819](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1819) *** @@ -35,7 +35,7 @@ Defined in: [packages/ai/src/types.ts:1801](https://github.com/TanStack/ai/blob/ model: string; ``` -Defined in: [packages/ai/src/types.ts:1802](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1802) +Defined in: [packages/ai/src/types.ts:1820](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1820) *** @@ -45,7 +45,7 @@ Defined in: [packages/ai/src/types.ts:1802](https://github.com/TanStack/ai/blob/ ranking: object[]; ``` -Defined in: [packages/ai/src/types.ts:1804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1804) +Defined in: [packages/ai/src/types.ts:1822](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1822) Scored results, highest relevance first. @@ -75,7 +75,7 @@ score: number; rerankedDocuments: TDocument[]; ``` -Defined in: [packages/ai/src/types.ts:1806](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1806) +Defined in: [packages/ai/src/types.ts:1824](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1824) The documents reordered by relevance — `ranking.map(r => r.document)`. @@ -87,7 +87,7 @@ The documents reordered by relevance — `ranking.map(r => r.document)`. usage: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) +Defined in: [packages/ai/src/types.ts:1832](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1832) Usage for the request. Rerank typically bills in provider-defined "search units" (`usage.billed = { quantity, unit: 'units' }`) rather than tokens. diff --git a/docs/reference/interfaces/ResponseFormat.md b/docs/reference/interfaces/ResponseFormat.md index 84384518b8..4f4d5a24e2 100644 --- a/docs/reference/interfaces/ResponseFormat.md +++ b/docs/reference/interfaces/ResponseFormat.md @@ -5,7 +5,7 @@ title: ResponseFormat # Interface: ResponseFormat\ -Defined in: [packages/ai/src/types.ts:827](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L827) +Defined in: [packages/ai/src/types.ts:845](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L845) Structured output format specification. @@ -33,7 +33,7 @@ TypeScript type of the expected data structure (for type safety) optional __data?: TData; ``` -Defined in: [packages/ai/src/types.ts:905](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L905) +Defined in: [packages/ai/src/types.ts:923](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L923) **`Internal`** @@ -50,7 +50,7 @@ Allows the SDK to know what type to expect when parsing the response. optional json_schema?: object; ``` -Defined in: [packages/ai/src/types.ts:844](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L844) +Defined in: [packages/ai/src/types.ts:862](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L862) JSON schema specification (required when type is "json_schema"). @@ -139,7 +139,7 @@ https://platform.openai.com/docs/guides/structured-outputs#strict-mode type: "json_object" | "json_schema"; ``` -Defined in: [packages/ai/src/types.ts:836](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L836) +Defined in: [packages/ai/src/types.ts:854](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L854) Type of structured output. diff --git a/docs/reference/interfaces/RunErrorEvent.md b/docs/reference/interfaces/RunErrorEvent.md index 4cd9eee572..2622d3c6e3 100644 --- a/docs/reference/interfaces/RunErrorEvent.md +++ b/docs/reference/interfaces/RunErrorEvent.md @@ -5,7 +5,7 @@ title: RunErrorEvent # Interface: RunErrorEvent -Defined in: [packages/ai/src/types.ts:1207](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1207) +Defined in: [packages/ai/src/types.ts:1225](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1225) Emitted when an error occurs during a run. @@ -25,7 +25,7 @@ Spec `usage[]` is provider/model token counts. Interrupt errors live in optional error?: object; ``` -Defined in: [packages/ai/src/types.ts:1220](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1220) +Defined in: [packages/ai/src/types.ts:1238](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1238) Nested payload kept for in-process / durability consumers. @@ -49,7 +49,7 @@ message: string; optional metadata?: object & Record; ``` -Defined in: [packages/ai/src/types.ts:1221](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1221) +Defined in: [packages/ai/src/types.ts:1239](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1239) #### Type Declaration @@ -67,7 +67,7 @@ optional tanstack?: TanStackRunMetadata; optional model?: string; ``` -Defined in: [packages/ai/src/types.ts:1218](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1218) +Defined in: [packages/ai/src/types.ts:1236](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1236) Restored on the client from `metadata.tanstack`. @@ -79,7 +79,7 @@ Restored on the client from `metadata.tanstack`. optional runId?: string; ``` -Defined in: [packages/ai/src/types.ts:1216](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1216) +Defined in: [packages/ai/src/types.ts:1234](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1234) Restored on the client from `metadata.tanstack`. @@ -91,7 +91,7 @@ Restored on the client from `metadata.tanstack`. optional threadId?: string; ``` -Defined in: [packages/ai/src/types.ts:1214](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1214) +Defined in: [packages/ai/src/types.ts:1232](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1232) Restored on the client from `metadata.tanstack`. @@ -103,7 +103,7 @@ Restored on the client from `metadata.tanstack`. type: RUN_ERROR; ``` -Defined in: [packages/ai/src/types.ts:1211](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1211) +Defined in: [packages/ai/src/types.ts:1229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1229) *** @@ -115,4 +115,4 @@ optional usage?: | SpecTokenUsage[]; ``` -Defined in: [packages/ai/src/types.ts:1212](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1212) +Defined in: [packages/ai/src/types.ts:1230](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1230) diff --git a/docs/reference/interfaces/RunFinishedEvent.md b/docs/reference/interfaces/RunFinishedEvent.md index 5773dda17f..ee54cd84d0 100644 --- a/docs/reference/interfaces/RunFinishedEvent.md +++ b/docs/reference/interfaces/RunFinishedEvent.md @@ -5,7 +5,7 @@ title: RunFinishedEvent # Interface: RunFinishedEvent -Defined in: [packages/ai/src/types.ts:1187](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1187) +Defined in: [packages/ai/src/types.ts:1205](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1205) Emitted when a run completes successfully. @@ -25,7 +25,7 @@ Spec `usage[]` is provider/model token counts. TanStack leftovers live in optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null; ``` -Defined in: [packages/ai/src/types.ts:1196](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1196) +Defined in: [packages/ai/src/types.ts:1214](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1214) Restored on the client from `metadata.tanstack`. @@ -37,7 +37,7 @@ Restored on the client from `metadata.tanstack`. optional metadata?: object & Record; ``` -Defined in: [packages/ai/src/types.ts:1197](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1197) +Defined in: [packages/ai/src/types.ts:1215](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1215) #### Type Declaration @@ -55,7 +55,7 @@ optional tanstack?: TanStackRunMetadata; optional model?: string; ``` -Defined in: [packages/ai/src/types.ts:1194](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1194) +Defined in: [packages/ai/src/types.ts:1212](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1212) Restored on the client from `metadata.tanstack`. @@ -67,7 +67,7 @@ Restored on the client from `metadata.tanstack`. type: RUN_FINISHED; ``` -Defined in: [packages/ai/src/types.ts:1191](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1191) +Defined in: [packages/ai/src/types.ts:1209](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1209) *** @@ -79,4 +79,4 @@ optional usage?: | SpecTokenUsage[]; ``` -Defined in: [packages/ai/src/types.ts:1192](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1192) +Defined in: [packages/ai/src/types.ts:1210](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1210) diff --git a/docs/reference/interfaces/RunStartedEvent.md b/docs/reference/interfaces/RunStartedEvent.md index 3d11d38c85..cccf5576f6 100644 --- a/docs/reference/interfaces/RunStartedEvent.md +++ b/docs/reference/interfaces/RunStartedEvent.md @@ -5,7 +5,7 @@ title: RunStartedEvent # Interface: RunStartedEvent -Defined in: [packages/ai/src/types.ts:1150](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1150) +Defined in: [packages/ai/src/types.ts:1168](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1168) Emitted when a run starts. This is the first event in any streaming response. diff --git a/docs/reference/interfaces/SandboxFileCustomEvent.md b/docs/reference/interfaces/SandboxFileCustomEvent.md index b9f9b24c31..9756442531 100644 --- a/docs/reference/interfaces/SandboxFileCustomEvent.md +++ b/docs/reference/interfaces/SandboxFileCustomEvent.md @@ -5,7 +5,7 @@ title: SandboxFileCustomEvent # Interface: SandboxFileCustomEvent -Defined in: [packages/ai/src/types.ts:1445](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1445) +Defined in: [packages/ai/src/types.ts:1463](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1463) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "sandbox.file"; ``` -Defined in: [packages/ai/src/types.ts:1446](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1446) +Defined in: [packages/ai/src/types.ts:1464](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1464) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1447](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1447) +Defined in: [packages/ai/src/types.ts:1465](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1465) #### path diff --git a/docs/reference/interfaces/SandboxFileDiffEvent.md b/docs/reference/interfaces/SandboxFileDiffEvent.md index 0fe3e94e7e..5f5f3069e6 100644 --- a/docs/reference/interfaces/SandboxFileDiffEvent.md +++ b/docs/reference/interfaces/SandboxFileDiffEvent.md @@ -5,7 +5,7 @@ title: SandboxFileDiffEvent # Interface: SandboxFileDiffEvent -Defined in: [packages/ai/src/types.ts:1453](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1453) +Defined in: [packages/ai/src/types.ts:1471](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1471) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "sandbox.file.diff"; ``` -Defined in: [packages/ai/src/types.ts:1454](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1454) +Defined in: [packages/ai/src/types.ts:1472](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1472) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1455](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1455) +Defined in: [packages/ai/src/types.ts:1473](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1473) #### diff diff --git a/docs/reference/interfaces/ServerTool.md b/docs/reference/interfaces/ServerTool.md index 1143a4b24e..26e3b5de2c 100644 --- a/docs/reference/interfaces/ServerTool.md +++ b/docs/reference/interfaces/ServerTool.md @@ -97,7 +97,7 @@ Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:101](https description: string; ``` -Defined in: [packages/ai/src/types.ts:700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L700) +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) Clear description of what the tool does. @@ -122,7 +122,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) +Defined in: [packages/ai/src/types.ts:798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L798) Optional function to execute when the model calls this tool. @@ -220,7 +220,7 @@ type({ optional lazy?: boolean; ``` -Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) +Defined in: [packages/ai/src/types.ts:804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L804) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -236,7 +236,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L789) +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) Additional metadata for adapters or custom extensions @@ -252,7 +252,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: [packages/ai/src/types.ts:690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L690) +Defined in: [packages/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L708) Unique name of the tool (used by the model to call it). diff --git a/docs/reference/interfaces/SessionIdEvent.md b/docs/reference/interfaces/SessionIdEvent.md index 96eed24fe8..ff363bcad7 100644 --- a/docs/reference/interfaces/SessionIdEvent.md +++ b/docs/reference/interfaces/SessionIdEvent.md @@ -5,7 +5,7 @@ title: SessionIdEvent # Interface: SessionIdEvent -Defined in: [packages/ai/src/types.ts:1463](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1463) +Defined in: [packages/ai/src/types.ts:1481](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1481) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: `${string}.session-id`; ``` -Defined in: [packages/ai/src/types.ts:1464](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1464) +Defined in: [packages/ai/src/types.ts:1482](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1482) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1465](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1465) +Defined in: [packages/ai/src/types.ts:1483](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1483) #### sessionId diff --git a/docs/reference/interfaces/SkillLimitErrorInit.md b/docs/reference/interfaces/SkillLimitErrorInit.md new file mode 100644 index 0000000000..cca67bff88 --- /dev/null +++ b/docs/reference/interfaces/SkillLimitErrorInit.md @@ -0,0 +1,77 @@ +--- +id: SkillLimitErrorInit +title: SkillLimitErrorInit +--- + +# Interface: SkillLimitErrorInit + +Defined in: [packages/ai/src/utilities/errors.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L13) + +Thrown when a skills request exceeds a provider limit. Lives in core (rather +than `@tanstack/ai-skills`) so the native tool factories in `ai-anthropic` +and `openai-base` can throw it without depending on the skills package; +`@tanstack/ai-skills` re-exports it for the portable path. + +`path` distinguishes the native provider cap (e.g. Anthropic's 8-skill +limit) from a portable-path limit, so a portable user isn't sent chasing a +cap that only applies to hosted skills. + +## Properties + +### actual + +```ts +actual: number; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L18) + +*** + +### allowed + +```ts +allowed: number; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L17) + +*** + +### limit + +```ts +limit: string; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L16) + +*** + +### offending + +```ts +offending: string[]; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L19) + +*** + +### path + +```ts +path: "native" | "portable"; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L15) + +*** + +### provider + +```ts +provider: "anthropic" | "openai" | "gemini" | "other"; +``` + +Defined in: [packages/ai/src/utilities/errors.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L14) diff --git a/docs/reference/interfaces/SnippetRegisteredEvent.md b/docs/reference/interfaces/SnippetRegisteredEvent.md index fb6674b53b..41611dbc75 100644 --- a/docs/reference/interfaces/SnippetRegisteredEvent.md +++ b/docs/reference/interfaces/SnippetRegisteredEvent.md @@ -5,7 +5,7 @@ title: SnippetRegisteredEvent # Interface: SnippetRegisteredEvent -Defined in: [packages/ai/src/types.ts:1510](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1510) +Defined in: [packages/ai/src/types.ts:1528](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1528) Custom event for extensibility. @@ -26,7 +26,7 @@ erase discriminant property access on [KnownCustomEvent](../type-aliases/KnownCu optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "snippet:registered"; ``` -Defined in: [packages/ai/src/types.ts:1511](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1511) +Defined in: [packages/ai/src/types.ts:1529](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1529) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1512](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1512) +Defined in: [packages/ai/src/types.ts:1530](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1530) #### description diff --git a/docs/reference/interfaces/StateDeltaEvent.md b/docs/reference/interfaces/StateDeltaEvent.md index c570d9139c..81889cad68 100644 --- a/docs/reference/interfaces/StateDeltaEvent.md +++ b/docs/reference/interfaces/StateDeltaEvent.md @@ -5,7 +5,7 @@ title: StateDeltaEvent # Interface: StateDeltaEvent -Defined in: [packages/ai/src/types.ts:1335](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1335) +Defined in: [packages/ai/src/types.ts:1353](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1353) Emitted to provide an incremental state update. diff --git a/docs/reference/interfaces/StateSnapshotEvent.md b/docs/reference/interfaces/StateSnapshotEvent.md index 17b39a2ac2..d733511efe 100644 --- a/docs/reference/interfaces/StateSnapshotEvent.md +++ b/docs/reference/interfaces/StateSnapshotEvent.md @@ -5,7 +5,7 @@ title: StateSnapshotEvent # Interface: StateSnapshotEvent -Defined in: [packages/ai/src/types.ts:1328](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1328) +Defined in: [packages/ai/src/types.ts:1346](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1346) Emitted to provide a full state snapshot. diff --git a/docs/reference/interfaces/StepFinishedEvent.md b/docs/reference/interfaces/StepFinishedEvent.md index c5e4320cf6..0be3a5f328 100644 --- a/docs/reference/interfaces/StepFinishedEvent.md +++ b/docs/reference/interfaces/StepFinishedEvent.md @@ -5,7 +5,7 @@ title: StepFinishedEvent # Interface: StepFinishedEvent -Defined in: [packages/ai/src/types.ts:1308](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1308) +Defined in: [packages/ai/src/types.ts:1326](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1326) Emitted when a thinking/reasoning step finishes. diff --git a/docs/reference/interfaces/StepStartedEvent.md b/docs/reference/interfaces/StepStartedEvent.md index a48a5b4c1e..00d1df73e6 100644 --- a/docs/reference/interfaces/StepStartedEvent.md +++ b/docs/reference/interfaces/StepStartedEvent.md @@ -5,7 +5,7 @@ title: StepStartedEvent # Interface: StepStartedEvent -Defined in: [packages/ai/src/types.ts:1301](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1301) +Defined in: [packages/ai/src/types.ts:1319](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1319) Emitted when a thinking/reasoning step starts. diff --git a/docs/reference/interfaces/StreamProcessorEvents.md b/docs/reference/interfaces/StreamProcessorEvents.md index 3a4283c9b9..bc63bd7350 100644 --- a/docs/reference/interfaces/StreamProcessorEvents.md +++ b/docs/reference/interfaces/StreamProcessorEvents.md @@ -5,7 +5,7 @@ title: StreamProcessorEvents # Interface: StreamProcessorEvents -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L77) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L78) Events emitted by the StreamProcessor @@ -17,7 +17,7 @@ Events emitted by the StreamProcessor optional onApprovalRequest?: (args) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:92](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L92) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:93](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L93) #### Parameters @@ -51,7 +51,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:92](https://git optional onCustomEvent?: (eventType, data, context) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L100) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L101) #### Parameters @@ -81,7 +81,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:100](https://gi optional onError?: (error) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L84) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:85](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L85) #### Parameters @@ -101,7 +101,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:84](https://git optional onMessagesChange?: (messages) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L79) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:80](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L80) #### Parameters @@ -121,7 +121,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:79](https://git optional onStreamEnd?: (message) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L83) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L84) #### Parameters @@ -141,7 +141,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:83](https://git optional onStreamStart?: () => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:82](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L82) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L83) #### Returns @@ -155,7 +155,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:82](https://git optional onStructuredOutputChange?: (args) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L119) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L120) #### Parameters @@ -209,7 +209,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:119](https://gi optional onTextUpdate?: (messageId, content) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L107) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L108) #### Parameters @@ -233,7 +233,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:107](https://gi optional onThinkingUpdate?: (messageId, stepId, content) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L114) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:115](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L115) #### Parameters @@ -261,7 +261,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:114](https://gi optional onToolCall?: (args) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L87) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L88) #### Parameters @@ -291,7 +291,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:87](https://git optional onToolCallStateChange?: (messageId, toolCallId, state, args) => void; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L108) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L109) #### Parameters diff --git a/docs/reference/interfaces/StreamProcessorOptions.md b/docs/reference/interfaces/StreamProcessorOptions.md index 0e6f9c7eef..9448ccb85b 100644 --- a/docs/reference/interfaces/StreamProcessorOptions.md +++ b/docs/reference/interfaces/StreamProcessorOptions.md @@ -5,7 +5,7 @@ title: StreamProcessorOptions # Interface: StreamProcessorOptions -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L135) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L136) Options for StreamProcessor @@ -17,7 +17,7 @@ Options for StreamProcessor optional chunkStrategy?: ChunkStrategy; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L136) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L137) *** @@ -27,7 +27,7 @@ Defined in: [packages/ai/src/activities/chat/stream/processor.ts:136](https://gi optional events?: StreamProcessorEvents; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:138](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L138) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L139) Event-driven handlers @@ -39,7 +39,7 @@ Event-driven handlers optional initialMessages?: UIMessage[]; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:145](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L145) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L146) Initial messages to populate the processor @@ -51,7 +51,7 @@ Initial messages to populate the processor optional jsonParser?: object; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L139) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L140) #### parse @@ -77,6 +77,6 @@ parse: (jsonString) => any; optional recording?: boolean; ``` -Defined in: [packages/ai/src/activities/chat/stream/processor.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L143) +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L144) Enable recording for replay testing diff --git a/docs/reference/interfaces/StructuredOutputCompleteEvent.md b/docs/reference/interfaces/StructuredOutputCompleteEvent.md index db5dc14cfd..9ba0bd5ea3 100644 --- a/docs/reference/interfaces/StructuredOutputCompleteEvent.md +++ b/docs/reference/interfaces/StructuredOutputCompleteEvent.md @@ -5,7 +5,7 @@ title: StructuredOutputCompleteEvent # Interface: StructuredOutputCompleteEvent\ -Defined in: [packages/ai/src/types.ts:1371](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1371) +Defined in: [packages/ai/src/types.ts:1389](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1389) Final event of a streaming structured-output run. Carries the validated `object` (typed as `T` after the orchestrator runs Standard Schema parsing), @@ -42,7 +42,7 @@ if (chunk.type === 'CUSTOM' && chunk.name === 'structured-output.complete') { optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "structured-output.complete"; ``` -Defined in: [packages/ai/src/types.ts:1374](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1374) +Defined in: [packages/ai/src/types.ts:1392](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1392) #### Overrides @@ -72,7 +72,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1375](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1375) +Defined in: [packages/ai/src/types.ts:1393](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1393) #### object diff --git a/docs/reference/interfaces/StructuredOutputPart.md b/docs/reference/interfaces/StructuredOutputPart.md index 6baf6e3ebf..8bded0f6ff 100644 --- a/docs/reference/interfaces/StructuredOutputPart.md +++ b/docs/reference/interfaces/StructuredOutputPart.md @@ -5,7 +5,7 @@ title: StructuredOutputPart # Interface: StructuredOutputPart\ -Defined in: [packages/ai/src/types.ts:472](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L472) +Defined in: [packages/ai/src/types.ts:480](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L480) StructuredOutputPart — a typed structured response attached to the assistant message that produced it. Generic over the schema-inferred data type so @@ -27,7 +27,7 @@ to `messages[i].parts[j].data`. Defaults to `unknown` so untyped consumers optional data?: TData; ``` -Defined in: [packages/ai/src/types.ts:478](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L478) +Defined in: [packages/ai/src/types.ts:486](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L486) Validated final object — only set when `status === 'complete'`. @@ -39,7 +39,7 @@ Validated final object — only set when `status === 'complete'`. optional errorMessage?: string; ``` -Defined in: [packages/ai/src/types.ts:484](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L484) +Defined in: [packages/ai/src/types.ts:492](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L492) Populated when `status === 'error'`. @@ -51,7 +51,7 @@ Populated when `status === 'error'`. optional partial?: DeepPartial; ``` -Defined in: [packages/ai/src/types.ts:476](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L476) +Defined in: [packages/ai/src/types.ts:484](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L484) Progressive parse of `raw` via parsePartialJSON — populated while streaming and after complete. @@ -63,7 +63,7 @@ Progressive parse of `raw` via parsePartialJSON — populated while streaming an raw: string; ``` -Defined in: [packages/ai/src/types.ts:480](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L480) +Defined in: [packages/ai/src/types.ts:488](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L488) Accumulating JSON buffer. Source of truth for wire round-trip. @@ -75,7 +75,7 @@ Accumulating JSON buffer. Source of truth for wire round-trip. optional reasoning?: string; ``` -Defined in: [packages/ai/src/types.ts:482](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L482) +Defined in: [packages/ai/src/types.ts:490](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L490) Optional chain-of-thought surfaced by reasoning models alongside the structured output. @@ -87,7 +87,7 @@ Optional chain-of-thought surfaced by reasoning models alongside the structured status: "error" | "complete" | "streaming"; ``` -Defined in: [packages/ai/src/types.ts:474](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L474) +Defined in: [packages/ai/src/types.ts:482](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L482) *** @@ -97,4 +97,4 @@ Defined in: [packages/ai/src/types.ts:474](https://github.com/TanStack/ai/blob/m type: "structured-output"; ``` -Defined in: [packages/ai/src/types.ts:473](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L473) +Defined in: [packages/ai/src/types.ts:481](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L481) diff --git a/docs/reference/interfaces/StructuredOutputStartEvent.md b/docs/reference/interfaces/StructuredOutputStartEvent.md index 4158f7852d..47e0ee174e 100644 --- a/docs/reference/interfaces/StructuredOutputStartEvent.md +++ b/docs/reference/interfaces/StructuredOutputStartEvent.md @@ -5,7 +5,7 @@ title: StructuredOutputStartEvent # Interface: StructuredOutputStartEvent -Defined in: [packages/ai/src/types.ts:1386](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1386) +Defined in: [packages/ai/src/types.ts:1404](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1404) Emitted at the start of a streaming structured-output run, before the JSON deltas. Tells consumers that the upcoming `TEXT_MESSAGE_CONTENT` deltas @@ -26,7 +26,7 @@ made per-message rather than globally. optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "structured-output.start"; ``` -Defined in: [packages/ai/src/types.ts:1387](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1387) +Defined in: [packages/ai/src/types.ts:1405](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1405) #### Overrides @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1388](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1388) +Defined in: [packages/ai/src/types.ts:1406](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1406) #### messageId diff --git a/docs/reference/interfaces/SummarizationOptions.md b/docs/reference/interfaces/SummarizationOptions.md index d0572407f8..b0697c5f89 100644 --- a/docs/reference/interfaces/SummarizationOptions.md +++ b/docs/reference/interfaces/SummarizationOptions.md @@ -5,7 +5,7 @@ title: SummarizationOptions # Interface: SummarizationOptions\ -Defined in: [packages/ai/src/types.ts:1711](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1711) +Defined in: [packages/ai/src/types.ts:1729](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1729) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/ai/src/types.ts:1711](https://github.com/TanStack/ai/blob/ optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:1741](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1741) +Defined in: [packages/ai/src/types.ts:1759](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1759) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -35,7 +35,7 @@ supported. Request-specific — never store on a global client config. optional focus?: string[]; ``` -Defined in: [packages/ai/src/types.ts:1718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1718) +Defined in: [packages/ai/src/types.ts:1736](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1736) *** @@ -45,7 +45,7 @@ Defined in: [packages/ai/src/types.ts:1718](https://github.com/TanStack/ai/blob/ logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:1735](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1735) +Defined in: [packages/ai/src/types.ts:1753](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1753) Internal logger threaded from the summarize() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks. @@ -58,7 +58,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. optional maxLength?: number; ``` -Defined in: [packages/ai/src/types.ts:1716](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1716) +Defined in: [packages/ai/src/types.ts:1734](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1734) *** @@ -68,7 +68,7 @@ Defined in: [packages/ai/src/types.ts:1716](https://github.com/TanStack/ai/blob/ model: string; ``` -Defined in: [packages/ai/src/types.ts:1714](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1714) +Defined in: [packages/ai/src/types.ts:1732](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1732) *** @@ -78,7 +78,7 @@ Defined in: [packages/ai/src/types.ts:1714](https://github.com/TanStack/ai/blob/ optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:1720](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1720) +Defined in: [packages/ai/src/types.ts:1738](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1738) Provider-specific options forwarded by the summarize() activity. @@ -90,7 +90,7 @@ Provider-specific options forwarded by the summarize() activity. optional runId?: string; ``` -Defined in: [packages/ai/src/types.ts:1729](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1729) +Defined in: [packages/ai/src/types.ts:1747](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1747) Run identity forwarded from the summarize() activity. When set, the streaming adapter stamps it onto the emitted `RUN_STARTED` (via the wrapped @@ -107,7 +107,7 @@ their own. optional style?: "bullet-points" | "paragraph" | "concise"; ``` -Defined in: [packages/ai/src/types.ts:1717](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1717) +Defined in: [packages/ai/src/types.ts:1735](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1735) *** @@ -117,7 +117,7 @@ Defined in: [packages/ai/src/types.ts:1717](https://github.com/TanStack/ai/blob/ text: string; ``` -Defined in: [packages/ai/src/types.ts:1715](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1715) +Defined in: [packages/ai/src/types.ts:1733](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1733) *** @@ -127,4 +127,4 @@ Defined in: [packages/ai/src/types.ts:1715](https://github.com/TanStack/ai/blob/ optional threadId?: string; ``` -Defined in: [packages/ai/src/types.ts:1730](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1730) +Defined in: [packages/ai/src/types.ts:1748](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1748) diff --git a/docs/reference/interfaces/SummarizationResult.md b/docs/reference/interfaces/SummarizationResult.md index 98e980b4c6..e6b4e2f538 100644 --- a/docs/reference/interfaces/SummarizationResult.md +++ b/docs/reference/interfaces/SummarizationResult.md @@ -5,7 +5,7 @@ title: SummarizationResult # Interface: SummarizationResult -Defined in: [packages/ai/src/types.ts:1744](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1744) +Defined in: [packages/ai/src/types.ts:1762](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1762) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/ai/src/types.ts:1744](https://github.com/TanStack/ai/blob/ id: string; ``` -Defined in: [packages/ai/src/types.ts:1745](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1745) +Defined in: [packages/ai/src/types.ts:1763](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1763) *** @@ -25,7 +25,7 @@ Defined in: [packages/ai/src/types.ts:1745](https://github.com/TanStack/ai/blob/ model: string; ``` -Defined in: [packages/ai/src/types.ts:1746](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1746) +Defined in: [packages/ai/src/types.ts:1764](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1764) *** @@ -35,7 +35,7 @@ Defined in: [packages/ai/src/types.ts:1746](https://github.com/TanStack/ai/blob/ summary: string; ``` -Defined in: [packages/ai/src/types.ts:1747](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1747) +Defined in: [packages/ai/src/types.ts:1765](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1765) *** @@ -45,4 +45,4 @@ Defined in: [packages/ai/src/types.ts:1747](https://github.com/TanStack/ai/blob/ usage: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:1748](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1748) +Defined in: [packages/ai/src/types.ts:1766](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1766) diff --git a/docs/reference/interfaces/TTSOptions.md b/docs/reference/interfaces/TTSOptions.md index 180bb84cea..3ff7143dd2 100644 --- a/docs/reference/interfaces/TTSOptions.md +++ b/docs/reference/interfaces/TTSOptions.md @@ -5,7 +5,7 @@ title: TTSOptions # Interface: TTSOptions\ -Defined in: [packages/ai/src/types.ts:2211](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2211) +Defined in: [packages/ai/src/types.ts:2229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2229) Options for text-to-speech generation. These are the common options supported across providers. @@ -24,7 +24,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:2235](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2235) +Defined in: [packages/ai/src/types.ts:2253](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2253) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -38,7 +38,7 @@ supported. Request-specific — never store on a global client config. optional format?: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm"; ``` -Defined in: [packages/ai/src/types.ts:2219](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2219) +Defined in: [packages/ai/src/types.ts:2237](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2237) The output audio format @@ -50,7 +50,7 @@ The output audio format logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:2229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2229) +Defined in: [packages/ai/src/types.ts:2247](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2247) Internal logger threaded from the generateSpeech() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -64,7 +64,7 @@ catch blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:2213](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2213) +Defined in: [packages/ai/src/types.ts:2231](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2231) The model to use for TTS generation @@ -76,7 +76,7 @@ The model to use for TTS generation optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:2223](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2223) +Defined in: [packages/ai/src/types.ts:2241](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2241) Model-specific options for TTS generation @@ -88,7 +88,7 @@ Model-specific options for TTS generation optional speed?: number; ``` -Defined in: [packages/ai/src/types.ts:2221](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2221) +Defined in: [packages/ai/src/types.ts:2239](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2239) The speed of the generated audio (0.25 to 4.0) @@ -100,7 +100,7 @@ The speed of the generated audio (0.25 to 4.0) text: string; ``` -Defined in: [packages/ai/src/types.ts:2215](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2215) +Defined in: [packages/ai/src/types.ts:2233](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2233) The text to convert to speech @@ -112,6 +112,6 @@ The text to convert to speech optional voice?: string; ``` -Defined in: [packages/ai/src/types.ts:2217](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2217) +Defined in: [packages/ai/src/types.ts:2235](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2235) The voice to use for generation diff --git a/docs/reference/interfaces/TTSResult.md b/docs/reference/interfaces/TTSResult.md index e41030607f..c65d1959ab 100644 --- a/docs/reference/interfaces/TTSResult.md +++ b/docs/reference/interfaces/TTSResult.md @@ -5,7 +5,7 @@ title: TTSResult # Interface: TTSResult -Defined in: [packages/ai/src/types.ts:2241](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2241) +Defined in: [packages/ai/src/types.ts:2259](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2259) Result of text-to-speech generation. @@ -17,7 +17,7 @@ Result of text-to-speech generation. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2257](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2257) +Defined in: [packages/ai/src/types.ts:2275](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2275) Persisted artifact references for generated assets, when available @@ -29,7 +29,7 @@ Persisted artifact references for generated assets, when available audio: string; ``` -Defined in: [packages/ai/src/types.ts:2247](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2247) +Defined in: [packages/ai/src/types.ts:2265](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2265) Base64-encoded audio data @@ -41,7 +41,7 @@ Base64-encoded audio data optional contentType?: string; ``` -Defined in: [packages/ai/src/types.ts:2253](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2253) +Defined in: [packages/ai/src/types.ts:2271](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2271) Content type of the audio (e.g., 'audio/mp3') @@ -53,7 +53,7 @@ Content type of the audio (e.g., 'audio/mp3') optional duration?: number; ``` -Defined in: [packages/ai/src/types.ts:2251](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2251) +Defined in: [packages/ai/src/types.ts:2269](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2269) Duration of the audio in seconds, if available @@ -65,7 +65,7 @@ Duration of the audio in seconds, if available format: string; ``` -Defined in: [packages/ai/src/types.ts:2249](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2249) +Defined in: [packages/ai/src/types.ts:2267](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2267) Audio format of the generated audio @@ -77,7 +77,7 @@ Audio format of the generated audio id: string; ``` -Defined in: [packages/ai/src/types.ts:2243](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2243) +Defined in: [packages/ai/src/types.ts:2261](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2261) Unique identifier for the generation @@ -89,7 +89,7 @@ Unique identifier for the generation model: string; ``` -Defined in: [packages/ai/src/types.ts:2245](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2245) +Defined in: [packages/ai/src/types.ts:2263](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2263) Model used for generation @@ -101,6 +101,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2255](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2255) +Defined in: [packages/ai/src/types.ts:2273](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2273) Token usage information (if provided by the adapter) diff --git a/docs/reference/interfaces/TanStackRunMetadata.md b/docs/reference/interfaces/TanStackRunMetadata.md index 50d2f05f4f..00f5fbfc7e 100644 --- a/docs/reference/interfaces/TanStackRunMetadata.md +++ b/docs/reference/interfaces/TanStackRunMetadata.md @@ -5,7 +5,7 @@ title: TanStackRunMetadata # Interface: TanStackRunMetadata -Defined in: [packages/ai/src/types.ts:538](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L538) +Defined in: [packages/ai/src/types.ts:554](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L554) Shape of `metadata.tanstack` on run events. @@ -17,7 +17,7 @@ Shape of `metadata.tanstack` on run events. optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null; ``` -Defined in: [packages/ai/src/types.ts:540](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L540) +Defined in: [packages/ai/src/types.ts:556](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L556) *** @@ -27,7 +27,7 @@ Defined in: [packages/ai/src/types.ts:540](https://github.com/TanStack/ai/blob/m optional index?: number; ``` -Defined in: [packages/ai/src/types.ts:547](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L547) +Defined in: [packages/ai/src/types.ts:563](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L563) *** @@ -37,7 +37,7 @@ Defined in: [packages/ai/src/types.ts:547](https://github.com/TanStack/ai/blob/m optional input?: unknown; ``` -Defined in: [packages/ai/src/types.ts:550](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L550) +Defined in: [packages/ai/src/types.ts:566](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L566) Parsed `TOOL_CALL_END` input. Spec `TOOL_CALL_END` has no top-level `input`. @@ -49,7 +49,7 @@ Parsed `TOOL_CALL_END` input. Spec `TOOL_CALL_END` has no top-level `input`. optional interruptErrors?: readonly InterruptSubmissionError[]; ``` -Defined in: [packages/ai/src/types.ts:543](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L543) +Defined in: [packages/ai/src/types.ts:559](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L559) *** @@ -59,7 +59,7 @@ Defined in: [packages/ai/src/types.ts:543](https://github.com/TanStack/ai/blob/m optional model?: string; ``` -Defined in: [packages/ai/src/types.ts:539](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L539) +Defined in: [packages/ai/src/types.ts:555](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L555) *** @@ -69,7 +69,7 @@ Defined in: [packages/ai/src/types.ts:539](https://github.com/TanStack/ai/blob/m optional runId?: string; ``` -Defined in: [packages/ai/src/types.ts:545](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L545) +Defined in: [packages/ai/src/types.ts:561](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L561) *** @@ -79,7 +79,7 @@ Defined in: [packages/ai/src/types.ts:545](https://github.com/TanStack/ai/blob/m optional sessionId?: string; ``` -Defined in: [packages/ai/src/types.ts:546](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L546) +Defined in: [packages/ai/src/types.ts:562](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L562) *** @@ -89,7 +89,7 @@ Defined in: [packages/ai/src/types.ts:546](https://github.com/TanStack/ai/blob/m optional state?: ToolOutputState; ``` -Defined in: [packages/ai/src/types.ts:548](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L548) +Defined in: [packages/ai/src/types.ts:564](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L564) *** @@ -99,7 +99,7 @@ Defined in: [packages/ai/src/types.ts:548](https://github.com/TanStack/ai/blob/m optional threadId?: string; ``` -Defined in: [packages/ai/src/types.ts:544](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L544) +Defined in: [packages/ai/src/types.ts:560](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L560) *** @@ -109,6 +109,6 @@ Defined in: [packages/ai/src/types.ts:544](https://github.com/TanStack/ai/blob/m optional usage?: TokenUsageLeftover; ``` -Defined in: [packages/ai/src/types.ts:542](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L542) +Defined in: [packages/ai/src/types.ts:558](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L558) TokenUsage fields that have no AG-UI `usage[]` equivalent. diff --git a/docs/reference/interfaces/TextCompletionChunk.md b/docs/reference/interfaces/TextCompletionChunk.md index 2d4f41f688..028ad847f0 100644 --- a/docs/reference/interfaces/TextCompletionChunk.md +++ b/docs/reference/interfaces/TextCompletionChunk.md @@ -5,7 +5,7 @@ title: TextCompletionChunk # Interface: TextCompletionChunk -Defined in: [packages/ai/src/types.ts:1702](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1702) +Defined in: [packages/ai/src/types.ts:1720](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1720) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/ai/src/types.ts:1702](https://github.com/TanStack/ai/blob/ content: string; ``` -Defined in: [packages/ai/src/types.ts:1705](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1705) +Defined in: [packages/ai/src/types.ts:1723](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1723) *** @@ -25,7 +25,7 @@ Defined in: [packages/ai/src/types.ts:1705](https://github.com/TanStack/ai/blob/ optional finishReason?: "length" | "stop" | "content_filter" | null; ``` -Defined in: [packages/ai/src/types.ts:1707](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1707) +Defined in: [packages/ai/src/types.ts:1725](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1725) *** @@ -35,7 +35,7 @@ Defined in: [packages/ai/src/types.ts:1707](https://github.com/TanStack/ai/blob/ id: string; ``` -Defined in: [packages/ai/src/types.ts:1703](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1703) +Defined in: [packages/ai/src/types.ts:1721](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1721) *** @@ -45,7 +45,7 @@ Defined in: [packages/ai/src/types.ts:1703](https://github.com/TanStack/ai/blob/ model: string; ``` -Defined in: [packages/ai/src/types.ts:1704](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1704) +Defined in: [packages/ai/src/types.ts:1722](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1722) *** @@ -55,7 +55,7 @@ Defined in: [packages/ai/src/types.ts:1704](https://github.com/TanStack/ai/blob/ optional role?: "assistant"; ``` -Defined in: [packages/ai/src/types.ts:1706](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1706) +Defined in: [packages/ai/src/types.ts:1724](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1724) *** @@ -65,4 +65,4 @@ Defined in: [packages/ai/src/types.ts:1706](https://github.com/TanStack/ai/blob/ optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:1708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1708) +Defined in: [packages/ai/src/types.ts:1726](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1726) diff --git a/docs/reference/interfaces/TextMessageContentEvent.md b/docs/reference/interfaces/TextMessageContentEvent.md index 16e787471c..1635524e6f 100644 --- a/docs/reference/interfaces/TextMessageContentEvent.md +++ b/docs/reference/interfaces/TextMessageContentEvent.md @@ -5,7 +5,7 @@ title: TextMessageContentEvent # Interface: TextMessageContentEvent -Defined in: [packages/ai/src/types.ts:1236](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1236) +Defined in: [packages/ai/src/types.ts:1254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1254) Emitted when text content is generated (streaming tokens). diff --git a/docs/reference/interfaces/TextMessageEndEvent.md b/docs/reference/interfaces/TextMessageEndEvent.md index adbb4c57a0..ed9cff0918 100644 --- a/docs/reference/interfaces/TextMessageEndEvent.md +++ b/docs/reference/interfaces/TextMessageEndEvent.md @@ -5,7 +5,7 @@ title: TextMessageEndEvent # Interface: TextMessageEndEvent -Defined in: [packages/ai/src/types.ts:1243](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1243) +Defined in: [packages/ai/src/types.ts:1261](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1261) Emitted when a text message completes. diff --git a/docs/reference/interfaces/TextMessageStartEvent.md b/docs/reference/interfaces/TextMessageStartEvent.md index 283d93138d..e2893869bc 100644 --- a/docs/reference/interfaces/TextMessageStartEvent.md +++ b/docs/reference/interfaces/TextMessageStartEvent.md @@ -5,7 +5,7 @@ title: TextMessageStartEvent # Interface: TextMessageStartEvent -Defined in: [packages/ai/src/types.ts:1229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1229) +Defined in: [packages/ai/src/types.ts:1247](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1247) Emitted when a text message starts. diff --git a/docs/reference/interfaces/TextOptions.md b/docs/reference/interfaces/TextOptions.md index 07ea94eb46..43a8fed66e 100644 --- a/docs/reference/interfaces/TextOptions.md +++ b/docs/reference/interfaces/TextOptions.md @@ -5,7 +5,7 @@ title: TextOptions # Interface: TextOptions\ -Defined in: [packages/ai/src/types.ts:951](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L951) +Defined in: [packages/ai/src/types.ts:969](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L969) Options passed into the SDK and further piped to the AI provider. @@ -31,7 +31,7 @@ Options passed into the SDK and further piped to the AI provider. optional abortController?: AbortController; ``` -Defined in: [packages/ai/src/types.ts:1051](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1051) +Defined in: [packages/ai/src/types.ts:1069](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1069) AbortController for request cancellation. @@ -58,7 +58,7 @@ https://developer.mozilla.org/en-US/docs/Web/API/AbortController optional agentLoopStrategy?: AgentLoopStrategy; ``` -Defined in: [packages/ai/src/types.ts:979](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L979) +Defined in: [packages/ai/src/types.ts:997](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L997) *** @@ -68,7 +68,7 @@ Defined in: [packages/ai/src/types.ts:979](https://github.com/TanStack/ai/blob/m optional approvals?: ReadonlyMap; ``` -Defined in: [packages/ai/src/types.ts:1103](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1103) +Defined in: [packages/ai/src/types.ts:1121](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1121) Client approval decisions for this run, keyed by approval id. The engine populates this from approvals carried on the incoming messages. Harness @@ -84,7 +84,7 @@ here). Undefined for direct adapter usage outside the chat engine. optional capabilities?: CapabilityContext; ``` -Defined in: [packages/ai/src/types.ts:1094](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1094) +Defined in: [packages/ai/src/types.ts:1112](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1112) Middleware capability context for this run. The engine populates it with the live middleware context so harness adapters that declare @@ -101,7 +101,7 @@ direct adapter usage outside the chat engine. optional context?: TContext; ``` -Defined in: [packages/ai/src/types.ts:963](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L963) +Defined in: [packages/ai/src/types.ts:981](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L981) Runtime context provided by the caller and passed to middleware and server-side tool implementations. @@ -114,7 +114,7 @@ server-side tool implementations. optional conversationId?: string; ``` -Defined in: [packages/ai/src/types.ts:1037](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1037) +Defined in: [packages/ai/src/types.ts:1055](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1055) #### Deprecated @@ -135,7 +135,7 @@ Will be removed in a future major release. optional lazyToolsConfig?: LazyToolsConfig; ``` -Defined in: [packages/ai/src/types.ts:985](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L985) +Defined in: [packages/ai/src/types.ts:1003](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1003) Optional configuration for lazy-tool discovery (tools marked `lazy: true`). Tunes how much of each lazy tool's description appears in the discovery @@ -149,7 +149,7 @@ catalog. Optional — defaults to `{ includeDescription: 'none' }`. logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:1058](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1058) +Defined in: [packages/ai/src/types.ts:1076](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1076) Internal logger threaded from the chat entry point. Adapter implementations must call `logger.request()` before SDK calls, `logger.provider()` for each @@ -166,7 +166,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: [packages/ai/src/types.ts:957](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L957) +Defined in: [packages/ai/src/types.ts:975](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L975) *** @@ -176,7 +176,7 @@ Defined in: [packages/ai/src/types.ts:957](https://github.com/TanStack/ai/blob/m optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:996](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L996) +Defined in: [packages/ai/src/types.ts:1014](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1014) Observability metadata attached to this call. Surfaced to middleware, devtools, and the event client; values may be arbitrarily structured @@ -195,7 +195,7 @@ OpenAI's and OpenRouter's `metadata` are both Record). model: string; ``` -Defined in: [packages/ai/src/types.ts:956](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L956) +Defined in: [packages/ai/src/types.ts:974](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L974) *** @@ -205,7 +205,7 @@ Defined in: [packages/ai/src/types.ts:956](https://github.com/TanStack/ai/blob/m optional modelOptions?: TProviderOptionsForModel; ``` -Defined in: [packages/ai/src/types.ts:997](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L997) +Defined in: [packages/ai/src/types.ts:1015](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1015) *** @@ -215,7 +215,7 @@ Defined in: [packages/ai/src/types.ts:997](https://github.com/TanStack/ai/blob/m optional outputSchema?: SchemaInput; ``` -Defined in: [packages/ai/src/types.ts:1026](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1026) +Defined in: [packages/ai/src/types.ts:1044](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1044) Schema for structured output. @@ -250,7 +250,7 @@ Schema for structured output. optional parentRunId?: string; ``` -Defined in: [packages/ai/src/types.ts:1075](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1075) +Defined in: [packages/ai/src/types.ts:1093](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1093) Parent run ID for AG-UI protocol nested run correlation. Surfaced for observability/middleware; not consumed by the LLM call. @@ -263,7 +263,7 @@ Surfaced for observability/middleware; not consumed by the LLM call. optional request?: Request | RequestInit; ``` -Defined in: [packages/ai/src/types.ts:998](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L998) +Defined in: [packages/ai/src/types.ts:1016](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1016) *** @@ -273,7 +273,7 @@ Defined in: [packages/ai/src/types.ts:998](https://github.com/TanStack/ai/blob/m optional resume?: RunAgentResumeItem[]; ``` -Defined in: [packages/ai/src/types.ts:1084](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1084) +Defined in: [packages/ai/src/types.ts:1102](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1102) AG-UI interrupt resume responses supplied by the client on a follow-up run. A first-party generic item carries the original request in `metadata`. @@ -286,7 +286,7 @@ A first-party generic item carries the original request in `metadata`. optional runId?: string; ``` -Defined in: [packages/ai/src/types.ts:1070](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1070) +Defined in: [packages/ai/src/types.ts:1088](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1088) Run ID for AG-UI protocol run correlation. When provided, this will be used in RunStartedEvent and RunFinishedEvent. @@ -300,7 +300,7 @@ If not provided, a unique ID will be generated. optional state?: unknown; ``` -Defined in: [packages/ai/src/types.ts:1078](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1078) +Defined in: [packages/ai/src/types.ts:1096](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1096) Application state mirrored in a STATE_SNAPSHOT before an interrupt terminal. @@ -312,7 +312,7 @@ Application state mirrored in a STATE_SNAPSHOT before an interrupt terminal. optional systemPrompts?: SystemPrompt[]; ``` -Defined in: [packages/ai/src/types.ts:978](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L978) +Defined in: [packages/ai/src/types.ts:996](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L996) System prompts to include with the request. @@ -337,7 +337,7 @@ SystemPrompt optional threadId?: string; ``` -Defined in: [packages/ai/src/types.ts:1064](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1064) +Defined in: [packages/ai/src/types.ts:1082](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1082) Thread ID for AG-UI protocol run correlation. When provided, this will be used in RunStartedEvent and RunFinishedEvent. @@ -350,4 +350,4 @@ When provided, this will be used in RunStartedEvent and RunFinishedEvent. optional tools?: AnyTool[]; ``` -Defined in: [packages/ai/src/types.ts:958](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L958) +Defined in: [packages/ai/src/types.ts:976](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L976) diff --git a/docs/reference/interfaces/TextPart.md b/docs/reference/interfaces/TextPart.md index 576a9c0dab..05970e3cad 100644 --- a/docs/reference/interfaces/TextPart.md +++ b/docs/reference/interfaces/TextPart.md @@ -5,7 +5,7 @@ title: TextPart # Interface: TextPart\ -Defined in: [packages/ai/src/types.ts:400](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L400) +Defined in: [packages/ai/src/types.ts:404](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L404) Message parts - building blocks of UIMessage @@ -23,7 +23,7 @@ Message parts - building blocks of UIMessage content: string; ``` -Defined in: [packages/ai/src/types.ts:402](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L402) +Defined in: [packages/ai/src/types.ts:406](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L406) *** @@ -33,7 +33,7 @@ Defined in: [packages/ai/src/types.ts:402](https://github.com/TanStack/ai/blob/m optional metadata?: TMetadata; ``` -Defined in: [packages/ai/src/types.ts:403](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L403) +Defined in: [packages/ai/src/types.ts:407](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L407) *** @@ -43,4 +43,4 @@ Defined in: [packages/ai/src/types.ts:403](https://github.com/TanStack/ai/blob/m type: "text"; ``` -Defined in: [packages/ai/src/types.ts:401](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L401) +Defined in: [packages/ai/src/types.ts:405](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L405) diff --git a/docs/reference/interfaces/ThinkingPart.md b/docs/reference/interfaces/ThinkingPart.md index a1d4d0fb45..771b7dca60 100644 --- a/docs/reference/interfaces/ThinkingPart.md +++ b/docs/reference/interfaces/ThinkingPart.md @@ -5,7 +5,7 @@ title: ThinkingPart # Interface: ThinkingPart -Defined in: [packages/ai/src/types.ts:444](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L444) +Defined in: [packages/ai/src/types.ts:452](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L452) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/ai/src/types.ts:444](https://github.com/TanStack/ai/blob/m content: string; ``` -Defined in: [packages/ai/src/types.ts:446](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L446) +Defined in: [packages/ai/src/types.ts:454](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L454) *** @@ -25,7 +25,7 @@ Defined in: [packages/ai/src/types.ts:446](https://github.com/TanStack/ai/blob/m optional signature?: string; ``` -Defined in: [packages/ai/src/types.ts:448](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L448) +Defined in: [packages/ai/src/types.ts:456](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L456) *** @@ -35,7 +35,7 @@ Defined in: [packages/ai/src/types.ts:448](https://github.com/TanStack/ai/blob/m optional stepId?: string; ``` -Defined in: [packages/ai/src/types.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L447) +Defined in: [packages/ai/src/types.ts:455](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L455) *** @@ -45,4 +45,4 @@ Defined in: [packages/ai/src/types.ts:447](https://github.com/TanStack/ai/blob/m type: "thinking"; ``` -Defined in: [packages/ai/src/types.ts:445](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L445) +Defined in: [packages/ai/src/types.ts:453](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L453) diff --git a/docs/reference/interfaces/Tool.md b/docs/reference/interfaces/Tool.md index 91f304f30f..fd272850dd 100644 --- a/docs/reference/interfaces/Tool.md +++ b/docs/reference/interfaces/Tool.md @@ -5,7 +5,7 @@ title: Tool # Interface: Tool\ -Defined in: [packages/ai/src/types.ts:676](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L676) +Defined in: [packages/ai/src/types.ts:694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L694) Tool/Function definition for function calling. @@ -53,7 +53,7 @@ or plain JSON Schema objects for runtime validation and type safety. description: string; ``` -Defined in: [packages/ai/src/types.ts:700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L700) +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) Clear description of what the tool does. @@ -74,7 +74,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) +Defined in: [packages/ai/src/types.ts:798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L798) Optional function to execute when the model calls this tool. @@ -110,7 +110,7 @@ execute: async (args) => { optional inputSchema?: TInput; ``` -Defined in: [packages/ai/src/types.ts:740](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L740) +Defined in: [packages/ai/src/types.ts:758](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L758) Schema describing the tool's input parameters. @@ -164,7 +164,7 @@ type({ optional lazy?: boolean; ``` -Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) +Defined in: [packages/ai/src/types.ts:804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L804) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -176,7 +176,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L789) +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) Additional metadata for adapters or custom extensions @@ -188,7 +188,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: [packages/ai/src/types.ts:690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L690) +Defined in: [packages/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L708) Unique name of the tool (used by the model to call it). @@ -209,7 +209,7 @@ Must be unique within the tools array. optional needsApproval?: boolean; ``` -Defined in: [packages/ai/src/types.ts:783](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L783) +Defined in: [packages/ai/src/types.ts:801](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L801) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -221,7 +221,7 @@ If true, tool execution requires user approval before running. Works with both s optional outputSchema?: TOutput; ``` -Defined in: [packages/ai/src/types.ts:761](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L761) +Defined in: [packages/ai/src/types.ts:779](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L779) Optional schema for validating tool output. diff --git a/docs/reference/interfaces/ToolCallArgsEvent.md b/docs/reference/interfaces/ToolCallArgsEvent.md index 1edf512d89..ebf318f719 100644 --- a/docs/reference/interfaces/ToolCallArgsEvent.md +++ b/docs/reference/interfaces/ToolCallArgsEvent.md @@ -5,7 +5,7 @@ title: ToolCallArgsEvent # Interface: ToolCallArgsEvent -Defined in: [packages/ai/src/types.ts:1270](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1270) +Defined in: [packages/ai/src/types.ts:1288](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1288) Emitted when tool call arguments are streaming. diff --git a/docs/reference/interfaces/ToolCallEndEvent.md b/docs/reference/interfaces/ToolCallEndEvent.md index 28bdfea8fb..84d9137369 100644 --- a/docs/reference/interfaces/ToolCallEndEvent.md +++ b/docs/reference/interfaces/ToolCallEndEvent.md @@ -5,7 +5,7 @@ title: ToolCallEndEvent # Interface: ToolCallEndEvent -Defined in: [packages/ai/src/types.ts:1279](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1279) +Defined in: [packages/ai/src/types.ts:1297](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1297) Emitted when a tool call completes. @@ -25,7 +25,7 @@ Same `Pick` (not `extends`) rationale as [ToolCallStartEvent](ToolCallStartEvent optional input?: unknown; ``` -Defined in: [packages/ai/src/types.ts:1285](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1285) +Defined in: [packages/ai/src/types.ts:1303](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1303) Parsed tool arguments when the adapter already parsed them. @@ -37,7 +37,7 @@ Parsed tool arguments when the adapter already parsed them. optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1286](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1286) +Defined in: [packages/ai/src/types.ts:1304](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1304) *** @@ -47,4 +47,4 @@ Defined in: [packages/ai/src/types.ts:1286](https://github.com/TanStack/ai/blob/ type: "TOOL_CALL_END"; ``` -Defined in: [packages/ai/src/types.ts:1283](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1283) +Defined in: [packages/ai/src/types.ts:1301](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1301) diff --git a/docs/reference/interfaces/ToolCallPart.md b/docs/reference/interfaces/ToolCallPart.md index 476dbf8c13..2a6d9488d5 100644 --- a/docs/reference/interfaces/ToolCallPart.md +++ b/docs/reference/interfaces/ToolCallPart.md @@ -5,7 +5,7 @@ title: ToolCallPart # Interface: ToolCallPart\ -Defined in: [packages/ai/src/types.ts:406](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L406) +Defined in: [packages/ai/src/types.ts:410](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L410) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/ai/src/types.ts:406](https://github.com/TanStack/ai/blob/m optional approval?: object; ``` -Defined in: [packages/ai/src/types.ts:422](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L422) +Defined in: [packages/ai/src/types.ts:426](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L426) Approval metadata if tool requires user approval @@ -51,7 +51,7 @@ needsApproval: boolean; arguments: string; ``` -Defined in: [packages/ai/src/types.ts:410](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L410) +Defined in: [packages/ai/src/types.ts:414](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L414) *** @@ -61,7 +61,7 @@ Defined in: [packages/ai/src/types.ts:410](https://github.com/TanStack/ai/blob/m id: string; ``` -Defined in: [packages/ai/src/types.ts:408](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L408) +Defined in: [packages/ai/src/types.ts:412](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L412) *** @@ -71,7 +71,7 @@ Defined in: [packages/ai/src/types.ts:408](https://github.com/TanStack/ai/blob/m optional input?: unknown; ``` -Defined in: [packages/ai/src/types.ts:419](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L419) +Defined in: [packages/ai/src/types.ts:423](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L423) Parsed tool input. Set from the parsed arguments once they are complete (`state: 'input-complete'` and later). `undefined` while the raw @@ -88,7 +88,7 @@ available as a fallback. Typed per-tool on the client `ToolCallPart` (see optional metadata?: TMetadata; ``` -Defined in: [packages/ai/src/types.ts:433](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L433) +Defined in: [packages/ai/src/types.ts:437](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L437) Provider-specific metadata that round-trips with the tool call. Typed per-adapter via `TToolCallMetadata`. May follow the @@ -103,7 +103,7 @@ server tools (e.g. Anthropic `web_search`). name: string; ``` -Defined in: [packages/ai/src/types.ts:409](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L409) +Defined in: [packages/ai/src/types.ts:413](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L413) *** @@ -113,7 +113,7 @@ Defined in: [packages/ai/src/types.ts:409](https://github.com/TanStack/ai/blob/m optional output?: any; ``` -Defined in: [packages/ai/src/types.ts:428](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L428) +Defined in: [packages/ai/src/types.ts:432](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L432) Tool execution output (for client tools or after approval) @@ -125,7 +125,7 @@ Tool execution output (for client tools or after approval) state: ToolCallState; ``` -Defined in: [packages/ai/src/types.ts:420](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L420) +Defined in: [packages/ai/src/types.ts:424](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L424) *** @@ -135,4 +135,4 @@ Defined in: [packages/ai/src/types.ts:420](https://github.com/TanStack/ai/blob/m type: "tool-call"; ``` -Defined in: [packages/ai/src/types.ts:407](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L407) +Defined in: [packages/ai/src/types.ts:411](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L411) diff --git a/docs/reference/interfaces/ToolCallResultEvent.md b/docs/reference/interfaces/ToolCallResultEvent.md index 67ff4f4c1b..05ad72a427 100644 --- a/docs/reference/interfaces/ToolCallResultEvent.md +++ b/docs/reference/interfaces/ToolCallResultEvent.md @@ -5,7 +5,7 @@ title: ToolCallResultEvent # Interface: ToolCallResultEvent -Defined in: [packages/ai/src/types.ts:1294](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1294) +Defined in: [packages/ai/src/types.ts:1312](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1312) Emitted when a tool call result is available. diff --git a/docs/reference/interfaces/ToolCallStartEvent.md b/docs/reference/interfaces/ToolCallStartEvent.md index fbc9eb4600..581e90c04c 100644 --- a/docs/reference/interfaces/ToolCallStartEvent.md +++ b/docs/reference/interfaces/ToolCallStartEvent.md @@ -5,7 +5,7 @@ title: ToolCallStartEvent # Interface: ToolCallStartEvent -Defined in: [packages/ai/src/types.ts:1254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1254) +Defined in: [packages/ai/src/types.ts:1272](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1272) Emitted when a tool call starts. @@ -32,7 +32,7 @@ discriminated union — required for [KnownCustomEvent](../type-aliases/KnownCus optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1262](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1262) +Defined in: [packages/ai/src/types.ts:1280](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1280) Provider-specific metadata to carry into the ToolCall. @@ -44,7 +44,7 @@ Provider-specific metadata to carry into the ToolCall. optional toolName?: string; ``` -Defined in: [packages/ai/src/types.ts:1260](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1260) +Defined in: [packages/ai/src/types.ts:1278](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1278) Alias of `toolCallName`. Kept so existing stream readers still compile. @@ -56,4 +56,4 @@ Alias of `toolCallName`. Kept so existing stream readers still compile. type: "TOOL_CALL_START"; ``` -Defined in: [packages/ai/src/types.ts:1258](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1258) +Defined in: [packages/ai/src/types.ts:1276](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1276) diff --git a/docs/reference/interfaces/ToolConfig.md b/docs/reference/interfaces/ToolConfig.md index 5cca94d426..348b674ad7 100644 --- a/docs/reference/interfaces/ToolConfig.md +++ b/docs/reference/interfaces/ToolConfig.md @@ -5,7 +5,7 @@ title: ToolConfig # Interface: ToolConfig -Defined in: [packages/ai/src/types.ts:812](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L812) +Defined in: [packages/ai/src/types.ts:830](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L830) ## Indexable diff --git a/docs/reference/interfaces/ToolDefinition.md b/docs/reference/interfaces/ToolDefinition.md index 83dfdc4382..730f0b572b 100644 --- a/docs/reference/interfaces/ToolDefinition.md +++ b/docs/reference/interfaces/ToolDefinition.md @@ -129,7 +129,7 @@ tool so the tool-call part's `approval` field stays gated on it. description: string; ``` -Defined in: [packages/ai/src/types.ts:700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L700) +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) Clear description of what the tool does. @@ -156,7 +156,7 @@ optional execute?: (args, context?) => | Promise>; ``` -Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) +Defined in: [packages/ai/src/types.ts:798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L798) Optional function to execute when the model calls this tool. @@ -263,7 +263,7 @@ type({ optional lazy?: boolean; ``` -Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) +Defined in: [packages/ai/src/types.ts:804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L804) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -279,7 +279,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L789) +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) Additional metadata for adapters or custom extensions @@ -295,7 +295,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: [packages/ai/src/types.ts:690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L690) +Defined in: [packages/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L708) Unique name of the tool (used by the model to call it). diff --git a/docs/reference/interfaces/ToolDefinitionInstance.md b/docs/reference/interfaces/ToolDefinitionInstance.md index e10beae32c..1536afd765 100644 --- a/docs/reference/interfaces/ToolDefinitionInstance.md +++ b/docs/reference/interfaces/ToolDefinitionInstance.md @@ -95,7 +95,7 @@ Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:160](https description: string; ``` -Defined in: [packages/ai/src/types.ts:700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L700) +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) Clear description of what the tool does. @@ -120,7 +120,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) +Defined in: [packages/ai/src/types.ts:798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L798) Optional function to execute when the model calls this tool. @@ -218,7 +218,7 @@ type({ optional lazy?: boolean; ``` -Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) +Defined in: [packages/ai/src/types.ts:804](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L804) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -234,7 +234,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:789](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L789) +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) Additional metadata for adapters or custom extensions @@ -250,7 +250,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: [packages/ai/src/types.ts:690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L690) +Defined in: [packages/ai/src/types.ts:708](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L708) Unique name of the tool (used by the model to call it). diff --git a/docs/reference/interfaces/ToolInputAvailableEvent.md b/docs/reference/interfaces/ToolInputAvailableEvent.md index e025cac497..76e45e6b1c 100644 --- a/docs/reference/interfaces/ToolInputAvailableEvent.md +++ b/docs/reference/interfaces/ToolInputAvailableEvent.md @@ -5,7 +5,7 @@ title: ToolInputAvailableEvent # ~~Interface: ToolInputAvailableEvent~~ -Defined in: [packages/ai/src/types.ts:1422](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1422) +Defined in: [packages/ai/src/types.ts:1440](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1440) ## Deprecated @@ -24,7 +24,7 @@ compatibility event remains readable until 1.0. optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -38,7 +38,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "tool-input-available"; ``` -Defined in: [packages/ai/src/types.ts:1423](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1423) +Defined in: [packages/ai/src/types.ts:1441](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1441) #### Overrides @@ -54,7 +54,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1424](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1424) +Defined in: [packages/ai/src/types.ts:1442](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1442) #### ~~input~~ diff --git a/docs/reference/interfaces/TranscriptionOptions.md b/docs/reference/interfaces/TranscriptionOptions.md index 9b22ba842c..ebd305b74c 100644 --- a/docs/reference/interfaces/TranscriptionOptions.md +++ b/docs/reference/interfaces/TranscriptionOptions.md @@ -5,7 +5,7 @@ title: TranscriptionOptions # Interface: TranscriptionOptions\ -Defined in: [packages/ai/src/types.ts:2275](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2275) +Defined in: [packages/ai/src/types.ts:2293](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2293) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/ai/src/types.ts:2275](https://github.com/TanStack/ai/blob/ optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:2301](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2301) +Defined in: [packages/ai/src/types.ts:2319](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2319) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -35,7 +35,7 @@ supported. Request-specific — never store on a global client config. audio: string | ArrayBuffer | File | Blob; ``` -Defined in: [packages/ai/src/types.ts:2281](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2281) +Defined in: [packages/ai/src/types.ts:2299](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2299) The audio data to transcribe - can be base64 string, File, Blob, or Buffer @@ -47,7 +47,7 @@ The audio data to transcribe - can be base64 string, File, Blob, or Buffer optional language?: string; ``` -Defined in: [packages/ai/src/types.ts:2283](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2283) +Defined in: [packages/ai/src/types.ts:2301](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2301) The language of the audio in ISO-639-1 format (e.g., 'en') @@ -59,7 +59,7 @@ The language of the audio in ISO-639-1 format (e.g., 'en') logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:2295](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2295) +Defined in: [packages/ai/src/types.ts:2313](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2313) Internal logger threaded from the generateTranscription() entry point. Adapters must call logger.request() before the SDK call and logger.errors() @@ -73,7 +73,7 @@ in catch blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:2279](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2279) +Defined in: [packages/ai/src/types.ts:2297](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2297) The model to use for transcription @@ -85,7 +85,7 @@ The model to use for transcription optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:2289](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2289) +Defined in: [packages/ai/src/types.ts:2307](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2307) Model-specific options for transcription @@ -97,7 +97,7 @@ Model-specific options for transcription optional prompt?: string; ``` -Defined in: [packages/ai/src/types.ts:2285](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2285) +Defined in: [packages/ai/src/types.ts:2303](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2303) An optional prompt to guide the transcription @@ -109,6 +109,6 @@ An optional prompt to guide the transcription optional responseFormat?: TranscriptionResponseFormat; ``` -Defined in: [packages/ai/src/types.ts:2287](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2287) +Defined in: [packages/ai/src/types.ts:2305](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2305) The format of the transcription output diff --git a/docs/reference/interfaces/TranscriptionResult.md b/docs/reference/interfaces/TranscriptionResult.md index 414264644f..9d5708e4b0 100644 --- a/docs/reference/interfaces/TranscriptionResult.md +++ b/docs/reference/interfaces/TranscriptionResult.md @@ -5,7 +5,7 @@ title: TranscriptionResult # Interface: TranscriptionResult -Defined in: [packages/ai/src/types.ts:2337](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2337) +Defined in: [packages/ai/src/types.ts:2355](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2355) Result of audio transcription. @@ -17,7 +17,7 @@ Result of audio transcription. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2355](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2355) +Defined in: [packages/ai/src/types.ts:2373](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2373) Persisted artifact references for generated assets, when available @@ -29,7 +29,7 @@ Persisted artifact references for generated assets, when available optional duration?: number; ``` -Defined in: [packages/ai/src/types.ts:2347](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2347) +Defined in: [packages/ai/src/types.ts:2365](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2365) Duration of the audio in seconds @@ -41,7 +41,7 @@ Duration of the audio in seconds id: string; ``` -Defined in: [packages/ai/src/types.ts:2339](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2339) +Defined in: [packages/ai/src/types.ts:2357](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2357) Unique identifier for the transcription @@ -53,7 +53,7 @@ Unique identifier for the transcription optional language?: string; ``` -Defined in: [packages/ai/src/types.ts:2345](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2345) +Defined in: [packages/ai/src/types.ts:2363](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2363) Language detected or specified @@ -65,7 +65,7 @@ Language detected or specified model: string; ``` -Defined in: [packages/ai/src/types.ts:2341](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2341) +Defined in: [packages/ai/src/types.ts:2359](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2359) Model used for transcription @@ -77,7 +77,7 @@ Model used for transcription optional segments?: TranscriptionSegment[]; ``` -Defined in: [packages/ai/src/types.ts:2349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2349) +Defined in: [packages/ai/src/types.ts:2367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2367) Detailed segments with timing, if available @@ -89,7 +89,7 @@ Detailed segments with timing, if available text: string; ``` -Defined in: [packages/ai/src/types.ts:2343](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2343) +Defined in: [packages/ai/src/types.ts:2361](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2361) The full transcribed text @@ -101,7 +101,7 @@ The full transcribed text optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2353](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2353) +Defined in: [packages/ai/src/types.ts:2371](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2371) Token usage information (if provided by the adapter) @@ -113,6 +113,6 @@ Token usage information (if provided by the adapter) optional words?: TranscriptionWord[]; ``` -Defined in: [packages/ai/src/types.ts:2351](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2351) +Defined in: [packages/ai/src/types.ts:2369](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2369) Word-level timestamps, if available diff --git a/docs/reference/interfaces/TranscriptionSegment.md b/docs/reference/interfaces/TranscriptionSegment.md index 3657164301..6f23081511 100644 --- a/docs/reference/interfaces/TranscriptionSegment.md +++ b/docs/reference/interfaces/TranscriptionSegment.md @@ -5,7 +5,7 @@ title: TranscriptionSegment # Interface: TranscriptionSegment -Defined in: [packages/ai/src/types.ts:2307](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2307) +Defined in: [packages/ai/src/types.ts:2325](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2325) A single segment of transcribed audio with timing information. @@ -17,7 +17,7 @@ A single segment of transcribed audio with timing information. optional confidence?: number; ``` -Defined in: [packages/ai/src/types.ts:2317](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2317) +Defined in: [packages/ai/src/types.ts:2335](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2335) Confidence score (0-1), if available @@ -29,7 +29,7 @@ Confidence score (0-1), if available end: number; ``` -Defined in: [packages/ai/src/types.ts:2313](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2313) +Defined in: [packages/ai/src/types.ts:2331](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2331) End time of the segment in seconds @@ -41,7 +41,7 @@ End time of the segment in seconds id: number; ``` -Defined in: [packages/ai/src/types.ts:2309](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2309) +Defined in: [packages/ai/src/types.ts:2327](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2327) Unique identifier for the segment @@ -53,7 +53,7 @@ Unique identifier for the segment optional speaker?: string; ``` -Defined in: [packages/ai/src/types.ts:2319](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2319) +Defined in: [packages/ai/src/types.ts:2337](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2337) Speaker identifier, if diarization is enabled @@ -65,7 +65,7 @@ Speaker identifier, if diarization is enabled start: number; ``` -Defined in: [packages/ai/src/types.ts:2311](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2311) +Defined in: [packages/ai/src/types.ts:2329](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2329) Start time of the segment in seconds @@ -77,6 +77,6 @@ Start time of the segment in seconds text: string; ``` -Defined in: [packages/ai/src/types.ts:2315](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2315) +Defined in: [packages/ai/src/types.ts:2333](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2333) Transcribed text for this segment diff --git a/docs/reference/interfaces/TranscriptionWord.md b/docs/reference/interfaces/TranscriptionWord.md index 1455243cc5..8913d712a8 100644 --- a/docs/reference/interfaces/TranscriptionWord.md +++ b/docs/reference/interfaces/TranscriptionWord.md @@ -5,7 +5,7 @@ title: TranscriptionWord # Interface: TranscriptionWord -Defined in: [packages/ai/src/types.ts:2325](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2325) +Defined in: [packages/ai/src/types.ts:2343](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2343) A single word with timing information. @@ -17,7 +17,7 @@ A single word with timing information. end: number; ``` -Defined in: [packages/ai/src/types.ts:2331](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2331) +Defined in: [packages/ai/src/types.ts:2349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2349) End time in seconds @@ -29,7 +29,7 @@ End time in seconds start: number; ``` -Defined in: [packages/ai/src/types.ts:2329](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2329) +Defined in: [packages/ai/src/types.ts:2347](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2347) Start time in seconds @@ -41,6 +41,6 @@ Start time in seconds word: string; ``` -Defined in: [packages/ai/src/types.ts:2327](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2327) +Defined in: [packages/ai/src/types.ts:2345](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2345) The transcribed word diff --git a/docs/reference/interfaces/UIResourceEvent.md b/docs/reference/interfaces/UIResourceEvent.md index 8f8dc62fe6..9fe8858834 100644 --- a/docs/reference/interfaces/UIResourceEvent.md +++ b/docs/reference/interfaces/UIResourceEvent.md @@ -5,7 +5,7 @@ title: UIResourceEvent # Interface: UIResourceEvent -Defined in: [packages/ai/src/types.ts:1433](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1433) +Defined in: [packages/ai/src/types.ts:1451](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1451) Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into a UIResourcePart on the assistant UIMessage. Never enters model input. @@ -22,7 +22,7 @@ Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into optional metadata?: Record; ``` -Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1350) +Defined in: [packages/ai/src/types.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1368) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [packages/ai/src/types.ts:1350](https://github.com/TanStack/ai/blob/ name: "ui-resource"; ``` -Defined in: [packages/ai/src/types.ts:1434](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1434) +Defined in: [packages/ai/src/types.ts:1452](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1452) #### Overrides @@ -52,7 +52,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1349) +Defined in: [packages/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1367) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/ value: object; ``` -Defined in: [packages/ai/src/types.ts:1435](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1435) +Defined in: [packages/ai/src/types.ts:1453](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1453) #### meta? diff --git a/docs/reference/interfaces/UIResourcePart.md b/docs/reference/interfaces/UIResourcePart.md index 80cf5daeec..a3b485d41d 100644 --- a/docs/reference/interfaces/UIResourcePart.md +++ b/docs/reference/interfaces/UIResourcePart.md @@ -5,7 +5,7 @@ title: UIResourcePart # Interface: UIResourcePart -Defined in: [packages/ai/src/types.ts:487](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L487) +Defined in: [packages/ai/src/types.ts:495](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L495) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/ai/src/types.ts:487](https://github.com/TanStack/ai/blob/m optional meta?: Record; ``` -Defined in: [packages/ai/src/types.ts:501](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L501) +Defined in: [packages/ai/src/types.ts:509](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L509) Reserved for future passthrough of the resource/tool `_meta.ui` (e.g. frame-size hints). Currently always `undefined` — nothing populates this field yet. @@ -28,7 +28,7 @@ Reserved for future passthrough of the resource/tool `_meta.ui` (e.g. frame-size resource: object; ``` -Defined in: [packages/ai/src/types.ts:490](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L490) +Defined in: [packages/ai/src/types.ts:498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L498) The ui:// resource object in MCP-native shape — fed straight to the renderer. @@ -64,7 +64,7 @@ uri: string; optional serverId?: string; ``` -Defined in: [packages/ai/src/types.ts:492](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L492) +Defined in: [packages/ai/src/types.ts:500](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L500) Pool prefix / config key — routes interactive calls to the right MCP server. @@ -76,7 +76,7 @@ Pool prefix / config key — routes interactive calls to the right MCP server. toolCallId: string; ``` -Defined in: [packages/ai/src/types.ts:495](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L495) +Defined in: [packages/ai/src/types.ts:503](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L503) Links the widget to the originating tool call — correlates it with the sibling ToolCallPart/ToolResultPart in the same message. @@ -89,7 +89,7 @@ Links the widget to the originating tool call — correlates it with the toolName: string; ``` -Defined in: [packages/ai/src/types.ts:498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L498) +Defined in: [packages/ai/src/types.ts:506](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L506) Server-native (unprefixed) MCP tool name whose UI this resource renders. Required by the renderer (`@mcp-ui/client`'s `AppRenderer` `toolName` prop). @@ -102,4 +102,4 @@ Server-native (unprefixed) MCP tool name whose UI this resource renders. type: "ui-resource"; ``` -Defined in: [packages/ai/src/types.ts:488](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L488) +Defined in: [packages/ai/src/types.ts:496](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L496) diff --git a/docs/reference/interfaces/VideoGenerationOptions.md b/docs/reference/interfaces/VideoGenerationOptions.md index 504c57b1de..fcd4cbf535 100644 --- a/docs/reference/interfaces/VideoGenerationOptions.md +++ b/docs/reference/interfaces/VideoGenerationOptions.md @@ -5,7 +5,7 @@ title: VideoGenerationOptions # Interface: VideoGenerationOptions\ -Defined in: [packages/ai/src/types.ts:2108](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2108) +Defined in: [packages/ai/src/types.ts:2126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2126) **`Experimental`** @@ -36,7 +36,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: [packages/ai/src/types.ts:2144](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2144) +Defined in: [packages/ai/src/types.ts:2162](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2162) **`Experimental`** @@ -52,7 +52,7 @@ supported. Request-specific — never store on a global client config. optional duration?: TDuration; ``` -Defined in: [packages/ai/src/types.ts:2131](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2131) +Defined in: [packages/ai/src/types.ts:2149](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2149) **`Experimental`** @@ -68,7 +68,7 @@ map narrow this to the model's valid union; use logger: InternalLogger; ``` -Defined in: [packages/ai/src/types.ts:2138](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2138) +Defined in: [packages/ai/src/types.ts:2156](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2156) **`Experimental`** @@ -83,7 +83,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. model: string; ``` -Defined in: [packages/ai/src/types.ts:2114](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2114) +Defined in: [packages/ai/src/types.ts:2132](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2132) **`Experimental`** @@ -97,7 +97,7 @@ The model to use for video generation optional modelOptions?: TProviderOptions; ``` -Defined in: [packages/ai/src/types.ts:2133](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2133) +Defined in: [packages/ai/src/types.ts:2151](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2151) **`Experimental`** @@ -111,7 +111,7 @@ Model-specific options for video generation prompt: MediaPrompt; ``` -Defined in: [packages/ai/src/types.ts:2123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2123) +Defined in: [packages/ai/src/types.ts:2141](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2141) **`Experimental`** @@ -130,7 +130,7 @@ provider-native request (e.g. OpenAI Sora `input_reference`, fal optional size?: TSize; ``` -Defined in: [packages/ai/src/types.ts:2125](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2125) +Defined in: [packages/ai/src/types.ts:2143](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2143) **`Experimental`** diff --git a/docs/reference/interfaces/VideoJobResult.md b/docs/reference/interfaces/VideoJobResult.md index ab23cc8947..a378f2eb74 100644 --- a/docs/reference/interfaces/VideoJobResult.md +++ b/docs/reference/interfaces/VideoJobResult.md @@ -5,7 +5,7 @@ title: VideoJobResult # Interface: VideoJobResult -Defined in: [packages/ai/src/types.ts:2152](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2152) +Defined in: [packages/ai/src/types.ts:2170](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2170) **`Experimental`** @@ -21,7 +21,7 @@ Result of creating a video generation job. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2162](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2162) +Defined in: [packages/ai/src/types.ts:2180](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2180) **`Experimental`** @@ -37,7 +37,7 @@ refs for persisted prompt INPUTS (e.g. a start frame). jobId: string; ``` -Defined in: [packages/ai/src/types.ts:2154](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2154) +Defined in: [packages/ai/src/types.ts:2172](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2172) **`Experimental`** @@ -51,7 +51,7 @@ Unique job identifier for polling status model: string; ``` -Defined in: [packages/ai/src/types.ts:2156](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2156) +Defined in: [packages/ai/src/types.ts:2174](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2174) **`Experimental`** diff --git a/docs/reference/interfaces/VideoStatusResult.md b/docs/reference/interfaces/VideoStatusResult.md index e9bfb0c151..c62e7f3d5e 100644 --- a/docs/reference/interfaces/VideoStatusResult.md +++ b/docs/reference/interfaces/VideoStatusResult.md @@ -5,7 +5,7 @@ title: VideoStatusResult # Interface: VideoStatusResult -Defined in: [packages/ai/src/types.ts:2170](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2170) +Defined in: [packages/ai/src/types.ts:2188](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2188) **`Experimental`** @@ -21,7 +21,7 @@ Status of a video generation job. optional error?: string; ``` -Defined in: [packages/ai/src/types.ts:2178](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2178) +Defined in: [packages/ai/src/types.ts:2196](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2196) **`Experimental`** @@ -35,7 +35,7 @@ Error message if status is 'failed' jobId: string; ``` -Defined in: [packages/ai/src/types.ts:2172](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2172) +Defined in: [packages/ai/src/types.ts:2190](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2190) **`Experimental`** @@ -49,7 +49,7 @@ Job identifier optional progress?: number; ``` -Defined in: [packages/ai/src/types.ts:2176](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2176) +Defined in: [packages/ai/src/types.ts:2194](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2194) **`Experimental`** @@ -63,7 +63,7 @@ Progress percentage (0-100), if available status: "pending" | "processing" | "completed" | "failed"; ``` -Defined in: [packages/ai/src/types.ts:2174](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2174) +Defined in: [packages/ai/src/types.ts:2192](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2192) **`Experimental`** diff --git a/docs/reference/interfaces/VideoUrlResult.md b/docs/reference/interfaces/VideoUrlResult.md index ef00d701d9..3222aed029 100644 --- a/docs/reference/interfaces/VideoUrlResult.md +++ b/docs/reference/interfaces/VideoUrlResult.md @@ -5,7 +5,7 @@ title: VideoUrlResult # Interface: VideoUrlResult -Defined in: [packages/ai/src/types.ts:2186](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2186) +Defined in: [packages/ai/src/types.ts:2204](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2204) **`Experimental`** @@ -21,7 +21,7 @@ Result containing the URL to a generated video. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: [packages/ai/src/types.ts:2200](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2200) +Defined in: [packages/ai/src/types.ts:2218](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2218) **`Experimental`** @@ -35,7 +35,7 @@ Persisted artifact references for generated assets, when available optional expiresAt?: Date; ``` -Defined in: [packages/ai/src/types.ts:2192](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2192) +Defined in: [packages/ai/src/types.ts:2210](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2210) **`Experimental`** @@ -49,7 +49,7 @@ When the URL expires, if applicable jobId: string; ``` -Defined in: [packages/ai/src/types.ts:2188](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2188) +Defined in: [packages/ai/src/types.ts:2206](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2206) **`Experimental`** @@ -63,7 +63,7 @@ Job identifier url: string; ``` -Defined in: [packages/ai/src/types.ts:2190](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2190) +Defined in: [packages/ai/src/types.ts:2208](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2208) **`Experimental`** @@ -77,7 +77,7 @@ URL to the generated video optional usage?: TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:2198](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2198) +Defined in: [packages/ai/src/types.ts:2216](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2216) **`Experimental`** diff --git a/docs/reference/type-aliases/AGUIEvent.md b/docs/reference/type-aliases/AGUIEvent.md index d020cd89b7..7bc9476df4 100644 --- a/docs/reference/type-aliases/AGUIEvent.md +++ b/docs/reference/type-aliases/AGUIEvent.md @@ -31,6 +31,6 @@ type AGUIEvent = | ReasoningEncryptedValueEvent; ``` -Defined in: [packages/ai/src/types.ts:1641](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1641) +Defined in: [packages/ai/src/types.ts:1659](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1659) Union of all AG-UI events. diff --git a/docs/reference/type-aliases/AGUIEventType.md b/docs/reference/type-aliases/AGUIEventType.md index 6de3dd53eb..5792618884 100644 --- a/docs/reference/type-aliases/AGUIEventType.md +++ b/docs/reference/type-aliases/AGUIEventType.md @@ -9,7 +9,7 @@ title: AGUIEventType type AGUIEventType = `${EventType}`; ``` -Defined in: [packages/ai/src/types.ts:1122](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1122) +Defined in: [packages/ai/src/types.ts:1140](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1140) AG-UI Protocol event types. diff --git a/docs/reference/type-aliases/AgentLoopStrategy.md b/docs/reference/type-aliases/AgentLoopStrategy.md index 1c7aa126e0..3debae3303 100644 --- a/docs/reference/type-aliases/AgentLoopStrategy.md +++ b/docs/reference/type-aliases/AgentLoopStrategy.md @@ -9,7 +9,7 @@ title: AgentLoopStrategy type AgentLoopStrategy = (state) => boolean; ``` -Defined in: [packages/ai/src/types.ts:946](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L946) +Defined in: [packages/ai/src/types.ts:964](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L964) Strategy function that determines whether the agent loop should continue diff --git a/docs/reference/type-aliases/AnyTool.md b/docs/reference/type-aliases/AnyTool.md index a64d8002e2..305e88aa8c 100644 --- a/docs/reference/type-aliases/AnyTool.md +++ b/docs/reference/type-aliases/AnyTool.md @@ -9,7 +9,7 @@ title: AnyTool type AnyTool = Omit, "execute"> & object; ``` -Defined in: [packages/ai/src/types.ts:808](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L808) +Defined in: [packages/ai/src/types.ts:826](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L826) ## Type Declaration diff --git a/docs/reference/type-aliases/ChatStream.md b/docs/reference/type-aliases/ChatStream.md index 2047c6f0b3..14b90ba28f 100644 --- a/docs/reference/type-aliases/ChatStream.md +++ b/docs/reference/type-aliases/ChatStream.md @@ -11,7 +11,7 @@ type ChatStream = AsyncIterable< | KnownCustomEvent>; ``` -Defined in: [packages/ai/src/types.ts:1544](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1544) +Defined in: [packages/ai/src/types.ts:1562](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1562) The default chat streaming result: standard chunks plus every typed framework CUSTOM event, with the `value: any` catch-all excluded so diff --git a/docs/reference/type-aliases/ConstrainedModelMessage.md b/docs/reference/type-aliases/ConstrainedModelMessage.md index a9b1854d35..720c1f1baa 100644 --- a/docs/reference/type-aliases/ConstrainedModelMessage.md +++ b/docs/reference/type-aliases/ConstrainedModelMessage.md @@ -9,7 +9,7 @@ title: ConstrainedModelMessage type ConstrainedModelMessage = Omit & object; ``` -Defined in: [packages/ai/src/types.ts:581](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L581) +Defined in: [packages/ai/src/types.ts:599](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L599) A ModelMessage with content constrained to only allow content parts matching the specified input modalities. diff --git a/docs/reference/type-aliases/DeepPartial.md b/docs/reference/type-aliases/DeepPartial.md index f74c78a87c..95ef8d02ef 100644 --- a/docs/reference/type-aliases/DeepPartial.md +++ b/docs/reference/type-aliases/DeepPartial.md @@ -9,7 +9,7 @@ title: DeepPartial type DeepPartial = T extends ReadonlyArray ? DeepPartial[] : T extends object ? { [K in keyof T]?: DeepPartial } : T; ``` -Defined in: [packages/ai/src/types.ts:458](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L458) +Defined in: [packages/ai/src/types.ts:466](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L466) Recursive `Partial` — every nested field becomes optional. Used as the `partial` type on a streaming structured-output part since the progressive diff --git a/docs/reference/type-aliases/EmbeddingContentParts.md b/docs/reference/type-aliases/EmbeddingContentParts.md index b8ebd32c87..669c4f2650 100644 --- a/docs/reference/type-aliases/EmbeddingContentParts.md +++ b/docs/reference/type-aliases/EmbeddingContentParts.md @@ -11,7 +11,7 @@ type EmbeddingContentParts = ( | ImagePart)[]; ``` -Defined in: [packages/ai/src/types.ts:2389](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2389) +Defined in: [packages/ai/src/types.ts:2407](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2407) A fused multi-part embedding item: all parts are embedded together into a single vector (e.g. a product photo plus its caption). Written as a nested diff --git a/docs/reference/type-aliases/EmbeddingInputItem.md b/docs/reference/type-aliases/EmbeddingInputItem.md index 581e00b503..4479bcf489 100644 --- a/docs/reference/type-aliases/EmbeddingInputItem.md +++ b/docs/reference/type-aliases/EmbeddingInputItem.md @@ -13,7 +13,7 @@ type EmbeddingInputItem = | EmbeddingContentParts; ``` -Defined in: [packages/ai/src/types.ts:2398](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2398) +Defined in: [packages/ai/src/types.ts:2416](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2416) One embeddable item, producing exactly one vector. A bare string is shorthand for a text part; a nested [EmbeddingContentParts](EmbeddingContentParts.md) array diff --git a/docs/reference/type-aliases/EmbeddingInputItemFor.md b/docs/reference/type-aliases/EmbeddingInputItemFor.md index 9e468a4fa4..8ffc0548fe 100644 --- a/docs/reference/type-aliases/EmbeddingInputItemFor.md +++ b/docs/reference/type-aliases/EmbeddingInputItemFor.md @@ -12,7 +12,7 @@ type EmbeddingInputItemFor = | EmbeddingItemByModality[TModalities]; ``` -Defined in: [packages/ai/src/types.ts:2418](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2418) +Defined in: [packages/ai/src/types.ts:2436](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2436) Embedding item type narrowed to the modalities a specific model supports. `EmbeddingInputItemFor<'text'>` (a text-only model) is `string | TextPart`; diff --git a/docs/reference/type-aliases/EmbeddingModality.md b/docs/reference/type-aliases/EmbeddingModality.md index 6693aa5a2b..5c85b04a2b 100644 --- a/docs/reference/type-aliases/EmbeddingModality.md +++ b/docs/reference/type-aliases/EmbeddingModality.md @@ -9,7 +9,7 @@ title: EmbeddingModality type EmbeddingModality = "text" | "image"; ``` -Defined in: [packages/ai/src/types.ts:2368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2368) +Defined in: [packages/ai/src/types.ts:2386](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2386) Input modalities an embedding model can accept. Unlike [MediaPromptModality](MediaPromptModality.md), `'text'` is listed explicitly because diff --git a/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md b/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md index 60701b6360..d4c49fcd16 100644 --- a/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md +++ b/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md @@ -9,7 +9,7 @@ title: EmbeddingModelInputModalitiesByName type EmbeddingModelInputModalitiesByName = Record>; ``` -Defined in: [packages/ai/src/types.ts:2375](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2375) +Defined in: [packages/ai/src/types.ts:2393](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2393) Per-model map from model name to the input modalities it accepts, used as an adapter type parameter (`TModelInputModalitiesByName`). Models absent diff --git a/docs/reference/type-aliases/GeneratedAudio.md b/docs/reference/type-aliases/GeneratedAudio.md index c853d3682e..a8e7af4ae6 100644 --- a/docs/reference/type-aliases/GeneratedAudio.md +++ b/docs/reference/type-aliases/GeneratedAudio.md @@ -9,7 +9,7 @@ title: GeneratedAudio type GeneratedAudio = GeneratedMediaSource & object; ``` -Defined in: [packages/ai/src/types.ts:2075](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2075) +Defined in: [packages/ai/src/types.ts:2093](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2093) A single generated audio output diff --git a/docs/reference/type-aliases/GeneratedImage.md b/docs/reference/type-aliases/GeneratedImage.md index 391996f1cf..d974c7b8ee 100644 --- a/docs/reference/type-aliases/GeneratedImage.md +++ b/docs/reference/type-aliases/GeneratedImage.md @@ -9,7 +9,7 @@ title: GeneratedImage type GeneratedImage = GeneratedMediaSource & object; ``` -Defined in: [packages/ai/src/types.ts:2018](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2018) +Defined in: [packages/ai/src/types.ts:2036](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2036) A single generated image diff --git a/docs/reference/type-aliases/GeneratedMediaSource.md b/docs/reference/type-aliases/GeneratedMediaSource.md index a10b91914c..58b7fa91c4 100644 --- a/docs/reference/type-aliases/GeneratedMediaSource.md +++ b/docs/reference/type-aliases/GeneratedMediaSource.md @@ -17,7 +17,7 @@ type GeneratedMediaSource = }; ``` -Defined in: [packages/ai/src/types.ts:1959](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1959) +Defined in: [packages/ai/src/types.ts:1977](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1977) Source of a generated media asset. Exactly one of `url` or `b64Json` is present; the other is absent. Modeled as a mutually-exclusive union so the diff --git a/docs/reference/type-aliases/InputModalitiesTypes.md b/docs/reference/type-aliases/InputModalitiesTypes.md index 1726eee059..2d9a757920 100644 --- a/docs/reference/type-aliases/InputModalitiesTypes.md +++ b/docs/reference/type-aliases/InputModalitiesTypes.md @@ -9,7 +9,7 @@ title: InputModalitiesTypes type InputModalitiesTypes = object; ``` -Defined in: [packages/ai/src/types.ts:572](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L572) +Defined in: [packages/ai/src/types.ts:590](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L590) ## Properties @@ -19,7 +19,7 @@ Defined in: [packages/ai/src/types.ts:572](https://github.com/TanStack/ai/blob/m inputModalities: ReadonlyArray; ``` -Defined in: [packages/ai/src/types.ts:573](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L573) +Defined in: [packages/ai/src/types.ts:591](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L591) *** @@ -29,4 +29,4 @@ Defined in: [packages/ai/src/types.ts:573](https://github.com/TanStack/ai/blob/m messageMetadataByModality: DefaultMessageMetadataByModality; ``` -Defined in: [packages/ai/src/types.ts:574](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L574) +Defined in: [packages/ai/src/types.ts:592](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L592) diff --git a/docs/reference/type-aliases/Interrupt.md b/docs/reference/type-aliases/Interrupt.md index 47315c7c22..032b81f5f6 100644 --- a/docs/reference/type-aliases/Interrupt.md +++ b/docs/reference/type-aliases/Interrupt.md @@ -9,4 +9,4 @@ title: Interrupt type Interrupt = AGUIInterrupt; ``` -Defined in: [packages/ai/src/types.ts:1171](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1171) +Defined in: [packages/ai/src/types.ts:1189](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1189) diff --git a/docs/reference/type-aliases/KnownCustomEvent.md b/docs/reference/type-aliases/KnownCustomEvent.md index 4aee98337e..79cce3feaa 100644 --- a/docs/reference/type-aliases/KnownCustomEvent.md +++ b/docs/reference/type-aliases/KnownCustomEvent.md @@ -27,7 +27,7 @@ type KnownCustomEvent = | UIResourceEvent; ``` -Defined in: [packages/ai/src/types.ts:1520](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1520) +Defined in: [packages/ai/src/types.ts:1538](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1538) Every CUSTOM event TanStack AI itself emits, as a discriminated union on `name`. User-emitted custom events (via `emitCustomEvent` with a custom name) diff --git a/docs/reference/type-aliases/MediaInputRole.md b/docs/reference/type-aliases/MediaInputRole.md index cd9ba65a64..ef23a4ac07 100644 --- a/docs/reference/type-aliases/MediaInputRole.md +++ b/docs/reference/type-aliases/MediaInputRole.md @@ -15,7 +15,7 @@ type MediaInputRole = | "character"; ``` -Defined in: [packages/ai/src/types.ts:1828](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1828) +Defined in: [packages/ai/src/types.ts:1846](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1846) Optional role hint on a media input part (image / video / audio). Adapters read `metadata.role` to route the part to the provider-specific request diff --git a/docs/reference/type-aliases/MediaPrompt.md b/docs/reference/type-aliases/MediaPrompt.md index 6b15336920..f28ce032c2 100644 --- a/docs/reference/type-aliases/MediaPrompt.md +++ b/docs/reference/type-aliases/MediaPrompt.md @@ -9,7 +9,7 @@ title: MediaPrompt type MediaPrompt = string | MediaPromptPart[]; ``` -Defined in: [packages/ai/src/types.ts:1879](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1879) +Defined in: [packages/ai/src/types.ts:1897](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1897) Prompt accepted by `generateImage()` / `generateVideo()`: a plain string, or an ordered array of content parts for image-conditioned generation diff --git a/docs/reference/type-aliases/MediaPromptFor.md b/docs/reference/type-aliases/MediaPromptFor.md index 1146e62a83..df022db94a 100644 --- a/docs/reference/type-aliases/MediaPromptFor.md +++ b/docs/reference/type-aliases/MediaPromptFor.md @@ -13,7 +13,7 @@ type MediaPromptFor = | MediaPartByModality[TModalities])[]; ``` -Defined in: [packages/ai/src/types.ts:1900](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1900) +Defined in: [packages/ai/src/types.ts:1918](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1918) Prompt type narrowed to the modalities a specific model supports. `MediaPromptFor` (a text-only model) is `string | Array`; diff --git a/docs/reference/type-aliases/MediaPromptModality.md b/docs/reference/type-aliases/MediaPromptModality.md index 7a461629a8..63f44e2171 100644 --- a/docs/reference/type-aliases/MediaPromptModality.md +++ b/docs/reference/type-aliases/MediaPromptModality.md @@ -9,6 +9,6 @@ title: MediaPromptModality type MediaPromptModality = "image" | "video" | "audio"; ``` -Defined in: [packages/ai/src/types.ts:1884](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1884) +Defined in: [packages/ai/src/types.ts:1902](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1902) Non-text modalities a media-generation model can accept in its prompt. diff --git a/docs/reference/type-aliases/MediaPromptPart.md b/docs/reference/type-aliases/MediaPromptPart.md index 9ff0fb3417..a731595677 100644 --- a/docs/reference/type-aliases/MediaPromptPart.md +++ b/docs/reference/type-aliases/MediaPromptPart.md @@ -13,7 +13,7 @@ type MediaPromptPart = | AudioPart; ``` -Defined in: [packages/ai/src/types.ts:1861](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1861) +Defined in: [packages/ai/src/types.ts:1879](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1879) A single part of a multimodal media-generation prompt. Reuses the chat content-part shapes: text parts carry the instruction, image / video / diff --git a/docs/reference/type-aliases/MessagePart.md b/docs/reference/type-aliases/MessagePart.md index 0c1d9777bc..89f4d3a6d0 100644 --- a/docs/reference/type-aliases/MessagePart.md +++ b/docs/reference/type-aliases/MessagePart.md @@ -19,7 +19,7 @@ type MessagePart = | UIResourcePart; ``` -Defined in: [packages/ai/src/types.ts:504](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L504) +Defined in: [packages/ai/src/types.ts:512](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L512) ## Type Parameters diff --git a/docs/reference/type-aliases/ModelInputModalitiesByName.md b/docs/reference/type-aliases/ModelInputModalitiesByName.md index 213f067f30..dcc7636ea4 100644 --- a/docs/reference/type-aliases/ModelInputModalitiesByName.md +++ b/docs/reference/type-aliases/ModelInputModalitiesByName.md @@ -9,7 +9,7 @@ title: ModelInputModalitiesByName type ModelInputModalitiesByName = Record>; ``` -Defined in: [packages/ai/src/types.ts:1909](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1909) +Defined in: [packages/ai/src/types.ts:1927](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1927) Per-model map from model name to the prompt modalities it accepts, used as an adapter type parameter (`TModelInputModalitiesByName`). Models absent diff --git a/docs/reference/type-aliases/PersistedArtifactActivity.md b/docs/reference/type-aliases/PersistedArtifactActivity.md index c6f174e608..dafecf1ce9 100644 --- a/docs/reference/type-aliases/PersistedArtifactActivity.md +++ b/docs/reference/type-aliases/PersistedArtifactActivity.md @@ -9,4 +9,4 @@ title: PersistedArtifactActivity type PersistedArtifactActivity = "image" | "audio" | "tts" | "video" | "transcription"; ``` -Defined in: [packages/ai/src/types.ts:1973](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1973) +Defined in: [packages/ai/src/types.ts:1991](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1991) diff --git a/docs/reference/type-aliases/PersistedArtifactRole.md b/docs/reference/type-aliases/PersistedArtifactRole.md index a9e8aa2630..1b87d44b26 100644 --- a/docs/reference/type-aliases/PersistedArtifactRole.md +++ b/docs/reference/type-aliases/PersistedArtifactRole.md @@ -9,4 +9,4 @@ title: PersistedArtifactRole type PersistedArtifactRole = "input" | "output"; ``` -Defined in: [packages/ai/src/types.ts:1971](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1971) +Defined in: [packages/ai/src/types.ts:1989](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1989) diff --git a/docs/reference/type-aliases/RunAgentResumeItem.md b/docs/reference/type-aliases/RunAgentResumeItem.md index 73456e38cd..f07675a1dd 100644 --- a/docs/reference/type-aliases/RunAgentResumeItem.md +++ b/docs/reference/type-aliases/RunAgentResumeItem.md @@ -9,7 +9,7 @@ title: RunAgentResumeItem type RunAgentResumeItem = AGUIResumeEntry & object; ``` -Defined in: [packages/ai/src/types.ts:1175](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1175) +Defined in: [packages/ai/src/types.ts:1193](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1193) ## Type Declaration diff --git a/docs/reference/type-aliases/RunFinishedOutcome.md b/docs/reference/type-aliases/RunFinishedOutcome.md index 985efc5df6..dcad89ce6c 100644 --- a/docs/reference/type-aliases/RunFinishedOutcome.md +++ b/docs/reference/type-aliases/RunFinishedOutcome.md @@ -9,4 +9,4 @@ title: RunFinishedOutcome type RunFinishedOutcome = AGUIRunFinishedOutcome; ``` -Defined in: [packages/ai/src/types.ts:1173](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1173) +Defined in: [packages/ai/src/types.ts:1191](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1191) diff --git a/docs/reference/type-aliases/StreamChunk.md b/docs/reference/type-aliases/StreamChunk.md index e40c094025..f2c6fb63e5 100644 --- a/docs/reference/type-aliases/StreamChunk.md +++ b/docs/reference/type-aliases/StreamChunk.md @@ -9,7 +9,7 @@ title: StreamChunk type StreamChunk = AGUIEvent; ``` -Defined in: [packages/ai/src/types.ts:1669](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1669) +Defined in: [packages/ai/src/types.ts:1687](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1687) Chunk returned by the SDK during streaming chat completions. Uses the AG-UI protocol event format. diff --git a/docs/reference/type-aliases/StreamChunkType.md b/docs/reference/type-aliases/StreamChunkType.md index 7a5b999803..74367cdccc 100644 --- a/docs/reference/type-aliases/StreamChunkType.md +++ b/docs/reference/type-aliases/StreamChunkType.md @@ -9,7 +9,7 @@ title: StreamChunkType type StreamChunkType = AGUIEventType; ``` -Defined in: [packages/ai/src/types.ts:1128](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1128) +Defined in: [packages/ai/src/types.ts:1146](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1146) Stream chunk/event types (AG-UI protocol). diff --git a/docs/reference/type-aliases/StructuredOutputStream.md b/docs/reference/type-aliases/StructuredOutputStream.md index 7b86c0dcb9..4b88032aaa 100644 --- a/docs/reference/type-aliases/StructuredOutputStream.md +++ b/docs/reference/type-aliases/StructuredOutputStream.md @@ -14,7 +14,7 @@ type StructuredOutputStream = AsyncIterable< | ToolInputAvailableEvent>; ``` -Defined in: [packages/ai/src/types.ts:1580](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1580) +Defined in: [packages/ai/src/types.ts:1598](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1598) Public type for streams returned by `chat({ outputSchema, stream: true })`. diff --git a/docs/reference/type-aliases/TaggedCustomEvent.md b/docs/reference/type-aliases/TaggedCustomEvent.md index 88c28d538d..3915947fc2 100644 --- a/docs/reference/type-aliases/TaggedCustomEvent.md +++ b/docs/reference/type-aliases/TaggedCustomEvent.md @@ -13,7 +13,7 @@ type TaggedCustomEvent = | ToolInputAvailableEvent; ``` -Defined in: [packages/ai/src/types.ts:1694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1694) +Defined in: [packages/ai/src/types.ts:1712](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1712) Discriminated union of the orchestrator-tagged `CUSTOM` events. Each variant has a literal `name`, so a single narrow on `chunk.name` yields a typed diff --git a/docs/reference/type-aliases/ToolExecuteFunction.md b/docs/reference/type-aliases/ToolExecuteFunction.md index 53a0431d4b..7da154e700 100644 --- a/docs/reference/type-aliases/ToolExecuteFunction.md +++ b/docs/reference/type-aliases/ToolExecuteFunction.md @@ -13,7 +13,7 @@ type ToolExecuteFunction = undefined extends TContext | InferSchemaType; ``` -Defined in: [packages/ai/src/types.ts:649](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L649) +Defined in: [packages/ai/src/types.ts:667](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L667) ## Type Parameters diff --git a/docs/reference/type-aliases/ToolExecutionContext.md b/docs/reference/type-aliases/ToolExecutionContext.md index 010070bc01..dea28b5291 100644 --- a/docs/reference/type-aliases/ToolExecutionContext.md +++ b/docs/reference/type-aliases/ToolExecutionContext.md @@ -9,7 +9,7 @@ title: ToolExecutionContext type ToolExecutionContext = RuntimeContextField & object; ``` -Defined in: [packages/ai/src/types.ts:618](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L618) +Defined in: [packages/ai/src/types.ts:636](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L636) Context passed to tool execute functions, providing capabilities like emitting custom events during execution. diff --git a/docs/reference/type-aliases/TranscriptionResponseFormat.md b/docs/reference/type-aliases/TranscriptionResponseFormat.md index 1f0812fb8d..b9831d342a 100644 --- a/docs/reference/type-aliases/TranscriptionResponseFormat.md +++ b/docs/reference/type-aliases/TranscriptionResponseFormat.md @@ -9,7 +9,7 @@ title: TranscriptionResponseFormat type TranscriptionResponseFormat = "json" | "text" | "srt" | "verbose_json" | "vtt"; ``` -Defined in: [packages/ai/src/types.ts:2268](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2268) +Defined in: [packages/ai/src/types.ts:2286](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2286) Options for audio transcription. These are the common options supported across providers. diff --git a/docs/reference/type-aliases/UsageTotals.md b/docs/reference/type-aliases/UsageTotals.md index 16931ed092..9ca5eb7a22 100644 --- a/docs/reference/type-aliases/UsageTotals.md +++ b/docs/reference/type-aliases/UsageTotals.md @@ -9,7 +9,7 @@ title: UsageTotals type UsageTotals = TokenUsage; ``` -Defined in: [packages/ai/src/types.ts:1169](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1169) +Defined in: [packages/ai/src/types.ts:1187](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1187) ## Deprecated diff --git a/docs/reference/type-aliases/WireMessage.md b/docs/reference/type-aliases/WireMessage.md index 59100b8735..f2940e8cae 100644 --- a/docs/reference/type-aliases/WireMessage.md +++ b/docs/reference/type-aliases/WireMessage.md @@ -6,7 +6,7 @@ title: WireMessage # Type Alias: WireMessage ```ts -type WireMessage = +type WireMessage = | WireSystemMessage | WireUserMessage | WireAssistantMessage @@ -14,4 +14,4 @@ type WireMessage = | WireReasoningMessage; ``` -Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L70) +Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L65)