From 3255b07710f26e4bd1e3f22ec5fac5e9a52fb4f6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 24 Apr 2026 13:16:06 +0000 Subject: [PATCH] docs: regenerate API documentation --- .../reference/functions/createAudioOptions.md | 34 ++++++ .../functions/createSpeechOptions.md | 4 +- .../functions/createTranscriptionOptions.md | 4 +- docs/reference/functions/generateAudio.md | 51 +++++++++ docs/reference/functions/generateSpeech.md | 2 +- .../functions/generateTranscription.md | 4 +- docs/reference/functions/generateVideo.md | 2 +- docs/reference/functions/streamToText.md | 2 +- docs/reference/functions/toHttpResponse.md | 2 +- docs/reference/functions/toHttpStream.md | 2 +- .../functions/toServerSentEventsResponse.md | 2 +- .../functions/toServerSentEventsStream.md | 2 +- docs/reference/index.md | 10 +- docs/reference/interfaces/AudioAdapter.md | 105 ++++++++++++++++++ .../interfaces/AudioGenerationOptions.md | 79 +++++++++++++ .../interfaces/AudioGenerationResult.md | 76 +++++++++++++ .../DefaultMessageMetadataByModality.md | 12 +- docs/reference/interfaces/GeneratedImage.md | 46 -------- .../interfaces/ImageGenerationResult.md | 10 +- docs/reference/interfaces/TTSOptions.md | 16 +-- docs/reference/interfaces/TTSResult.md | 14 +-- .../interfaces/TranscriptionOptions.md | 16 +-- .../interfaces/TranscriptionResult.md | 16 +-- .../interfaces/TranscriptionSegment.md | 14 +-- .../reference/interfaces/TranscriptionWord.md | 8 +- .../interfaces/VideoGenerationOptions.md | 14 +-- docs/reference/interfaces/VideoJobResult.md | 6 +- .../reference/interfaces/VideoStatusResult.md | 10 +- docs/reference/interfaces/VideoUrlResult.md | 8 +- docs/reference/type-aliases/AIAdapter.md | 3 +- .../reference/type-aliases/AnyAudioAdapter.md | 15 +++ docs/reference/type-aliases/GeneratedAudio.md | 32 ++++++ docs/reference/type-aliases/GeneratedImage.md | 24 ++++ .../type-aliases/GeneratedMediaSource.md | 69 ++++++++++++ 34 files changed, 581 insertions(+), 133 deletions(-) create mode 100644 docs/reference/functions/createAudioOptions.md create mode 100644 docs/reference/functions/generateAudio.md create mode 100644 docs/reference/interfaces/AudioAdapter.md create mode 100644 docs/reference/interfaces/AudioGenerationOptions.md create mode 100644 docs/reference/interfaces/AudioGenerationResult.md delete mode 100644 docs/reference/interfaces/GeneratedImage.md create mode 100644 docs/reference/type-aliases/AnyAudioAdapter.md create mode 100644 docs/reference/type-aliases/GeneratedAudio.md create mode 100644 docs/reference/type-aliases/GeneratedImage.md create mode 100644 docs/reference/type-aliases/GeneratedMediaSource.md diff --git a/docs/reference/functions/createAudioOptions.md b/docs/reference/functions/createAudioOptions.md new file mode 100644 index 000000000..89f58378a --- /dev/null +++ b/docs/reference/functions/createAudioOptions.md @@ -0,0 +1,34 @@ +--- +id: createAudioOptions +title: createAudioOptions +--- + +# Function: createAudioOptions() + +```ts +function createAudioOptions(options): AudioActivityOptions; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/index.ts:209](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/index.ts#L209) + +Create typed options for the generateAudio() function without executing. + +## Type Parameters + +### TAdapter + +`TAdapter` *extends* [`AudioAdapter`](../interfaces/AudioAdapter.md)\<`string`, `AudioProviderOptions`\<`TAdapter`\>\> + +### TStream + +`TStream` *extends* `boolean` = `false` + +## Parameters + +### options + +`AudioActivityOptions`\<`TAdapter`, `TStream`\> + +## Returns + +`AudioActivityOptions`\<`TAdapter`, `TStream`\> diff --git a/docs/reference/functions/createSpeechOptions.md b/docs/reference/functions/createSpeechOptions.md index c28f1d955..cf28e6c3c 100644 --- a/docs/reference/functions/createSpeechOptions.md +++ b/docs/reference/functions/createSpeechOptions.md @@ -9,7 +9,7 @@ title: createSpeechOptions function createSpeechOptions(options): TTSActivityOptions; ``` -Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:213](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L213) +Defined in: [packages/typescript/ai/src/activities/generateSpeech/index.ts:223](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateSpeech/index.ts#L223) Create typed options for the generateSpeech() function without executing. @@ -17,7 +17,7 @@ Create typed options for the generateSpeech() function without executing. ### TAdapter -`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `object`\> +`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `TTSProviderOptions`\<`TAdapter`\>\> ### TStream diff --git a/docs/reference/functions/createTranscriptionOptions.md b/docs/reference/functions/createTranscriptionOptions.md index bd6fbbc4b..a68ae761f 100644 --- a/docs/reference/functions/createTranscriptionOptions.md +++ b/docs/reference/functions/createTranscriptionOptions.md @@ -9,7 +9,7 @@ title: createTranscriptionOptions function createTranscriptionOptions(options): TranscriptionActivityOptions; ``` -Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:231](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L231) +Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:251](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L251) Create typed options for the generateTranscription() function without executing. @@ -17,7 +17,7 @@ Create typed options for the generateTranscription() function without executing. ### TAdapter -`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `object`\> +`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `TranscriptionProviderOptions`\<`TAdapter`\>\> ### TStream diff --git a/docs/reference/functions/generateAudio.md b/docs/reference/functions/generateAudio.md new file mode 100644 index 000000000..52b6bea14 --- /dev/null +++ b/docs/reference/functions/generateAudio.md @@ -0,0 +1,51 @@ +--- +id: generateAudio +title: generateAudio +--- + +# Function: generateAudio() + +```ts +function generateAudio(options): AudioActivityResult; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/index.ts:115](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/index.ts#L115) + +Audio generation activity - generates audio from text prompts. + +Uses AI models to create music, sound effects, and other audio content. + +## Type Parameters + +### TAdapter + +`TAdapter` *extends* [`AudioAdapter`](../interfaces/AudioAdapter.md)\<`string`, `AudioProviderOptions`\<`TAdapter`\>\> + +### TStream + +`TStream` *extends* `boolean` = `false` + +## Parameters + +### options + +`AudioActivityOptions`\<`TAdapter`, `TStream`\> + +## Returns + +`AudioActivityResult`\<`TStream`\> + +## Example + +```ts +import { generateAudio } from '@tanstack/ai' +import { falAudio } from '@tanstack/ai-fal' + +const result = await generateAudio({ + adapter: falAudio('fal-ai/diffrhythm'), + prompt: 'An upbeat electronic track with synths', + duration: 10 +}) + +console.log(result.audio.url) // URL to generated audio +``` diff --git a/docs/reference/functions/generateSpeech.md b/docs/reference/functions/generateSpeech.md index c33d777dc..3b46735df 100644 --- a/docs/reference/functions/generateSpeech.md +++ b/docs/reference/functions/generateSpeech.md @@ -19,7 +19,7 @@ Uses AI text-to-speech models to create audio from natural language text. ### TAdapter -`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `object`\> +`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `TTSProviderOptions`\<`TAdapter`\>\> ### TStream diff --git a/docs/reference/functions/generateTranscription.md b/docs/reference/functions/generateTranscription.md index bfa949fc4..0b7de30aa 100644 --- a/docs/reference/functions/generateTranscription.md +++ b/docs/reference/functions/generateTranscription.md @@ -9,7 +9,7 @@ title: generateTranscription function generateTranscription(options): TranscriptionActivityResult; ``` -Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:143](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L143) +Defined in: [packages/typescript/ai/src/activities/generateTranscription/index.ts:146](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateTranscription/index.ts#L146) Transcription activity - converts audio to text. @@ -19,7 +19,7 @@ Uses AI speech-to-text models to transcribe audio content. ### TAdapter -`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `object`\> +`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `TranscriptionProviderOptions`\<`TAdapter`\>\> ### TStream diff --git a/docs/reference/functions/generateVideo.md b/docs/reference/functions/generateVideo.md index f679c5fa6..9ca9f6b29 100644 --- a/docs/reference/functions/generateVideo.md +++ b/docs/reference/functions/generateVideo.md @@ -9,7 +9,7 @@ title: generateVideo function generateVideo(options): TStream extends true ? AsyncIterable : Promise; ``` -Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:230](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L230) +Defined in: [packages/typescript/ai/src/activities/generateVideo/index.ts:231](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateVideo/index.ts#L231) **`Experimental`** diff --git a/docs/reference/functions/streamToText.md b/docs/reference/functions/streamToText.md index 1d86b84df..0a502e582 100644 --- a/docs/reference/functions/streamToText.md +++ b/docs/reference/functions/streamToText.md @@ -9,7 +9,7 @@ title: streamToText function streamToText(stream): Promise; ``` -Defined in: [packages/typescript/ai/src/stream-to-response.ts:23](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L23) +Defined in: [packages/typescript/ai/src/stream-to-response.ts:24](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L24) Collect all text content from a StreamChunk async iterable and return as a string. diff --git a/docs/reference/functions/toHttpResponse.md b/docs/reference/functions/toHttpResponse.md index 1a4e19df0..25edca773 100644 --- a/docs/reference/functions/toHttpResponse.md +++ b/docs/reference/functions/toHttpResponse.md @@ -9,7 +9,7 @@ title: toHttpResponse function toHttpResponse(stream, init?): Response; ``` -Defined in: [packages/typescript/ai/src/stream-to-response.ts:245](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L245) +Defined in: [packages/typescript/ai/src/stream-to-response.ts:240](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L240) Convert a StreamChunk async iterable to a Response in HTTP stream format (newline-delimited JSON) diff --git a/docs/reference/functions/toHttpStream.md b/docs/reference/functions/toHttpStream.md index 4249e1dad..445b43158 100644 --- a/docs/reference/functions/toHttpStream.md +++ b/docs/reference/functions/toHttpStream.md @@ -9,7 +9,7 @@ title: toHttpStream function toHttpStream(stream, abortController?): ReadableStream>; ``` -Defined in: [packages/typescript/ai/src/stream-to-response.ts:173](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L173) +Defined in: [packages/typescript/ai/src/stream-to-response.ts:171](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L171) Convert a StreamChunk async iterable to a ReadableStream in HTTP stream format (newline-delimited JSON) diff --git a/docs/reference/functions/toServerSentEventsResponse.md b/docs/reference/functions/toServerSentEventsResponse.md index 01dfe850e..94c1a1dd5 100644 --- a/docs/reference/functions/toServerSentEventsResponse.md +++ b/docs/reference/functions/toServerSentEventsResponse.md @@ -9,7 +9,7 @@ title: toServerSentEventsResponse function toServerSentEventsResponse(stream, init?): Response; ``` -Defined in: [packages/typescript/ai/src/stream-to-response.ts:122](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L122) +Defined in: [packages/typescript/ai/src/stream-to-response.ts:120](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L120) Convert a StreamChunk async iterable to a Response in Server-Sent Events format diff --git a/docs/reference/functions/toServerSentEventsStream.md b/docs/reference/functions/toServerSentEventsStream.md index 18a83564c..08e03cc87 100644 --- a/docs/reference/functions/toServerSentEventsStream.md +++ b/docs/reference/functions/toServerSentEventsStream.md @@ -9,7 +9,7 @@ title: toServerSentEventsStream function toServerSentEventsStream(stream, abortController?): ReadableStream>; ``` -Defined in: [packages/typescript/ai/src/stream-to-response.ts:49](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L49) +Defined in: [packages/typescript/ai/src/stream-to-response.ts:50](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/stream-to-response.ts#L50) Convert a StreamChunk async iterable to a ReadableStream in Server-Sent Events format diff --git a/docs/reference/index.md b/docs/reference/index.md index d74201b3c..efc8d6165 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -22,6 +22,9 @@ title: "@tanstack/ai" - [AbortInfo](interfaces/AbortInfo.md) - [AfterToolCallInfo](interfaces/AfterToolCallInfo.md) - [AgentLoopState](interfaces/AgentLoopState.md) +- [AudioAdapter](interfaces/AudioAdapter.md) +- [AudioGenerationOptions](interfaces/AudioGenerationOptions.md) +- [AudioGenerationResult](interfaces/AudioGenerationResult.md) - [AudioPart](interfaces/AudioPart.md) - [AudioVisualization](interfaces/AudioVisualization.md) - [BaseAGUIEvent](interfaces/BaseAGUIEvent.md) @@ -41,7 +44,6 @@ title: "@tanstack/ai" - [ErrorInfo](interfaces/ErrorInfo.md) - [ExtendedModelDef](interfaces/ExtendedModelDef.md) - [FinishInfo](interfaces/FinishInfo.md) -- [GeneratedImage](interfaces/GeneratedImage.md) - [ImageAdapter](interfaces/ImageAdapter.md) - [ImageGenerationOptions](interfaces/ImageGenerationOptions.md) - [ImageGenerationResult](interfaces/ImageGenerationResult.md) @@ -136,6 +138,7 @@ title: "@tanstack/ai" - [AGUIEvent](type-aliases/AGUIEvent.md) - [~~AGUIEventType~~](type-aliases/AGUIEventType.md) - [AIAdapter](type-aliases/AIAdapter.md) +- [AnyAudioAdapter](type-aliases/AnyAudioAdapter.md) - [AnyClientTool](type-aliases/AnyClientTool.md) - [AnyImageAdapter](type-aliases/AnyImageAdapter.md) - [AnySummarizeAdapter](type-aliases/AnySummarizeAdapter.md) @@ -151,6 +154,9 @@ title: "@tanstack/ai" - [ContentPartForInputModalitiesTypes](type-aliases/ContentPartForInputModalitiesTypes.md) - [ContentPartSource](type-aliases/ContentPartSource.md) - [DebugOption](type-aliases/DebugOption.md) +- [GeneratedAudio](type-aliases/GeneratedAudio.md) +- [GeneratedImage](type-aliases/GeneratedImage.md) +- [GeneratedMediaSource](type-aliases/GeneratedMediaSource.md) - [InferSchemaType](type-aliases/InferSchemaType.md) - [InferToolInput](type-aliases/InferToolInput.md) - [InferToolName](type-aliases/InferToolName.md) @@ -181,6 +187,7 @@ title: "@tanstack/ai" - [combineStrategies](functions/combineStrategies.md) - [convertMessagesToModelMessages](functions/convertMessagesToModelMessages.md) - [convertSchemaToJsonSchema](functions/convertSchemaToJsonSchema.md) +- [createAudioOptions](functions/createAudioOptions.md) - [createChatOptions](functions/createChatOptions.md) - [createFrozenRegistry](functions/createFrozenRegistry.md) - [createImageOptions](functions/createImageOptions.md) @@ -193,6 +200,7 @@ title: "@tanstack/ai" - [createVideoOptions](functions/createVideoOptions.md) - [detectImageMimeType](functions/detectImageMimeType.md) - [extendAdapter](functions/extendAdapter.md) +- [generateAudio](functions/generateAudio.md) - [generateImage](functions/generateImage.md) - [generateMessageId](functions/generateMessageId.md) - [generateSpeech](functions/generateSpeech.md) diff --git a/docs/reference/interfaces/AudioAdapter.md b/docs/reference/interfaces/AudioAdapter.md new file mode 100644 index 000000000..b2c0c389d --- /dev/null +++ b/docs/reference/interfaces/AudioAdapter.md @@ -0,0 +1,105 @@ +--- +id: AudioAdapter +title: AudioAdapter +--- + +# Interface: AudioAdapter\ + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:24](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L24) + +Audio generation adapter interface with pre-resolved generics. + +An adapter is created by a provider function: `provider('model')` → `adapter` +All type resolution happens at the provider call site, not in this interface. + +Generic parameters: +- TModel: The specific model name (e.g., 'fal-ai/diffrhythm') +- TProviderOptions: Provider-specific options (already resolved) + +## Type Parameters + +### TModel + +`TModel` *extends* `string` = `string` + +### TProviderOptions + +`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\> + +## Properties + +### ~types + +```ts +~types: object; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L38) + +**`Internal`** + +Type-only properties for inference. Not assigned at runtime. + +#### providerOptions + +```ts +providerOptions: TProviderOptions; +``` + +*** + +### generateAudio() + +```ts +generateAudio: (options) => Promise; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L45) + +Generate audio from a text prompt + +#### Parameters + +##### options + +[`AudioGenerationOptions`](AudioGenerationOptions.md)\<`TProviderOptions`\> + +#### Returns + +`Promise`\<[`AudioGenerationResult`](AudioGenerationResult.md)\> + +*** + +### kind + +```ts +readonly kind: "audio"; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L29) + +Discriminator for adapter kind - used to determine API shape + +*** + +### model + +```ts +readonly model: TModel; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L33) + +The model this adapter is configured for + +*** + +### name + +```ts +readonly name: string; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L31) + +Adapter name identifier diff --git a/docs/reference/interfaces/AudioGenerationOptions.md b/docs/reference/interfaces/AudioGenerationOptions.md new file mode 100644 index 000000000..85a21a101 --- /dev/null +++ b/docs/reference/interfaces/AudioGenerationOptions.md @@ -0,0 +1,79 @@ +--- +id: AudioGenerationOptions +title: AudioGenerationOptions +--- + +# Interface: AudioGenerationOptions\ + +Defined in: [packages/typescript/ai/src/types.ts:1274](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1274) + +Options for audio generation (music, sound effects, etc.). +These are the common options supported across providers. + +## Type Parameters + +### TProviderOptions + +`TProviderOptions` *extends* `object` = `object` + +## Properties + +### duration? + +```ts +optional duration: number; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1282](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1282) + +Desired duration in seconds + +*** + +### logger + +```ts +logger: InternalLogger; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1290](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1290) + +Internal logger threaded from the generateAudio() entry point. Adapters +must call logger.request() before the SDK call and logger.errors() in +catch blocks. + +*** + +### model + +```ts +model: string; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1278](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1278) + +The model to use for audio generation + +*** + +### modelOptions? + +```ts +optional modelOptions: TProviderOptions; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1284](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1284) + +Model-specific options for audio generation + +*** + +### prompt + +```ts +prompt: string; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1280](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1280) + +Text description of the desired audio diff --git a/docs/reference/interfaces/AudioGenerationResult.md b/docs/reference/interfaces/AudioGenerationResult.md new file mode 100644 index 000000000..7517448ec --- /dev/null +++ b/docs/reference/interfaces/AudioGenerationResult.md @@ -0,0 +1,76 @@ +--- +id: AudioGenerationResult +title: AudioGenerationResult +--- + +# Interface: AudioGenerationResult + +Defined in: [packages/typescript/ai/src/types.ts:1306](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1306) + +Result of audio generation + +## Properties + +### audio + +```ts +audio: GeneratedAudio; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1312](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1312) + +The generated audio + +*** + +### id + +```ts +id: string; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1308](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1308) + +Unique identifier for the generation + +*** + +### model + +```ts +model: string; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1310](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1310) + +Model used for generation + +*** + +### usage? + +```ts +optional usage: object; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1314](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1314) + +Token usage information (if available) + +#### inputTokens? + +```ts +optional inputTokens: number; +``` + +#### outputTokens? + +```ts +optional outputTokens: number; +``` + +#### totalTokens? + +```ts +optional totalTokens: number; +``` diff --git a/docs/reference/interfaces/DefaultMessageMetadataByModality.md b/docs/reference/interfaces/DefaultMessageMetadataByModality.md index d6e52317d..e892dd82e 100644 --- a/docs/reference/interfaces/DefaultMessageMetadataByModality.md +++ b/docs/reference/interfaces/DefaultMessageMetadataByModality.md @@ -5,7 +5,7 @@ title: DefaultMessageMetadataByModality # Interface: DefaultMessageMetadataByModality -Defined in: [packages/typescript/ai/src/types.ts:1457](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1457) +Defined in: [packages/typescript/ai/src/types.ts:1526](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1526) 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/typescript/ai/src/types.ts:1460](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1460) +Defined in: [packages/typescript/ai/src/types.ts:1529](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1529) *** @@ -28,7 +28,7 @@ Defined in: [packages/typescript/ai/src/types.ts:1460](https://github.com/TanSta document: unknown; ``` -Defined in: [packages/typescript/ai/src/types.ts:1462](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1462) +Defined in: [packages/typescript/ai/src/types.ts:1531](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1531) *** @@ -38,7 +38,7 @@ Defined in: [packages/typescript/ai/src/types.ts:1462](https://github.com/TanSta image: unknown; ``` -Defined in: [packages/typescript/ai/src/types.ts:1459](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1459) +Defined in: [packages/typescript/ai/src/types.ts:1528](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1528) *** @@ -48,7 +48,7 @@ Defined in: [packages/typescript/ai/src/types.ts:1459](https://github.com/TanSta text: unknown; ``` -Defined in: [packages/typescript/ai/src/types.ts:1458](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1458) +Defined in: [packages/typescript/ai/src/types.ts:1527](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1527) *** @@ -58,4 +58,4 @@ Defined in: [packages/typescript/ai/src/types.ts:1458](https://github.com/TanSta video: unknown; ``` -Defined in: [packages/typescript/ai/src/types.ts:1461](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1461) +Defined in: [packages/typescript/ai/src/types.ts:1530](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1530) diff --git a/docs/reference/interfaces/GeneratedImage.md b/docs/reference/interfaces/GeneratedImage.md deleted file mode 100644 index e964d6dcf..000000000 --- a/docs/reference/interfaces/GeneratedImage.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: GeneratedImage -title: GeneratedImage ---- - -# Interface: GeneratedImage - -Defined in: [packages/typescript/ai/src/types.ts:1225](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1225) - -A single generated image - -## Properties - -### b64Json? - -```ts -optional b64Json: string; -``` - -Defined in: [packages/typescript/ai/src/types.ts:1227](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1227) - -Base64-encoded image data - -*** - -### revisedPrompt? - -```ts -optional revisedPrompt: string; -``` - -Defined in: [packages/typescript/ai/src/types.ts:1231](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1231) - -Revised prompt used by the model (if applicable) - -*** - -### url? - -```ts -optional url: string; -``` - -Defined in: [packages/typescript/ai/src/types.ts:1229](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1229) - -URL to the generated image (may be temporary) diff --git a/docs/reference/interfaces/ImageGenerationResult.md b/docs/reference/interfaces/ImageGenerationResult.md index 7b4ab34ba..d64881043 100644 --- a/docs/reference/interfaces/ImageGenerationResult.md +++ b/docs/reference/interfaces/ImageGenerationResult.md @@ -5,7 +5,7 @@ title: ImageGenerationResult # Interface: ImageGenerationResult -Defined in: [packages/typescript/ai/src/types.ts:1237](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1237) +Defined in: [packages/typescript/ai/src/types.ts:1251](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1251) Result of image generation @@ -17,7 +17,7 @@ Result of image generation id: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1239](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1239) +Defined in: [packages/typescript/ai/src/types.ts:1253](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1253) Unique identifier for the generation @@ -29,7 +29,7 @@ Unique identifier for the generation images: GeneratedImage[]; ``` -Defined in: [packages/typescript/ai/src/types.ts:1243](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1243) +Defined in: [packages/typescript/ai/src/types.ts:1257](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1257) Array of generated images @@ -41,7 +41,7 @@ Array of generated images model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1241](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1241) +Defined in: [packages/typescript/ai/src/types.ts:1255](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1255) Model used for generation @@ -53,7 +53,7 @@ Model used for generation optional usage: object; ``` -Defined in: [packages/typescript/ai/src/types.ts:1245](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1245) +Defined in: [packages/typescript/ai/src/types.ts:1259](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1259) Token usage information (if available) diff --git a/docs/reference/interfaces/TTSOptions.md b/docs/reference/interfaces/TTSOptions.md index d5983f2b8..9ccbac1c9 100644 --- a/docs/reference/interfaces/TTSOptions.md +++ b/docs/reference/interfaces/TTSOptions.md @@ -5,7 +5,7 @@ title: TTSOptions # Interface: TTSOptions\ -Defined in: [packages/typescript/ai/src/types.ts:1333](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1333) +Defined in: [packages/typescript/ai/src/types.ts:1402](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1402) 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 format: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm"; ``` -Defined in: [packages/typescript/ai/src/types.ts:1341](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1341) +Defined in: [packages/typescript/ai/src/types.ts:1410](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1410) The output audio format @@ -36,7 +36,7 @@ The output audio format logger: InternalLogger; ``` -Defined in: [packages/typescript/ai/src/types.ts:1351](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1351) +Defined in: [packages/typescript/ai/src/types.ts:1420](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1420) Internal logger threaded from the generateSpeech() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -50,7 +50,7 @@ catch blocks. model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1335](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1335) +Defined in: [packages/typescript/ai/src/types.ts:1404](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1404) The model to use for TTS generation @@ -62,7 +62,7 @@ The model to use for TTS generation optional modelOptions: TProviderOptions; ``` -Defined in: [packages/typescript/ai/src/types.ts:1345](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1345) +Defined in: [packages/typescript/ai/src/types.ts:1414](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1414) Model-specific options for TTS generation @@ -74,7 +74,7 @@ Model-specific options for TTS generation optional speed: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1343](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1343) +Defined in: [packages/typescript/ai/src/types.ts:1412](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1412) The speed of the generated audio (0.25 to 4.0) @@ -86,7 +86,7 @@ The speed of the generated audio (0.25 to 4.0) text: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1337](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1337) +Defined in: [packages/typescript/ai/src/types.ts:1406](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1406) The text to convert to speech @@ -98,6 +98,6 @@ The text to convert to speech optional voice: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1339](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1339) +Defined in: [packages/typescript/ai/src/types.ts:1408](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1408) The voice to use for generation diff --git a/docs/reference/interfaces/TTSResult.md b/docs/reference/interfaces/TTSResult.md index 26e0c55e9..5e341381e 100644 --- a/docs/reference/interfaces/TTSResult.md +++ b/docs/reference/interfaces/TTSResult.md @@ -5,7 +5,7 @@ title: TTSResult # Interface: TTSResult -Defined in: [packages/typescript/ai/src/types.ts:1357](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1357) +Defined in: [packages/typescript/ai/src/types.ts:1426](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1426) Result of text-to-speech generation. @@ -17,7 +17,7 @@ Result of text-to-speech generation. audio: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1363](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1363) +Defined in: [packages/typescript/ai/src/types.ts:1432](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1432) Base64-encoded audio data @@ -29,7 +29,7 @@ Base64-encoded audio data optional contentType: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1369](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1369) +Defined in: [packages/typescript/ai/src/types.ts:1438](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1438) Content type of the audio (e.g., 'audio/mp3') @@ -41,7 +41,7 @@ Content type of the audio (e.g., 'audio/mp3') optional duration: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1367](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1367) +Defined in: [packages/typescript/ai/src/types.ts:1436](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1436) Duration of the audio in seconds, if available @@ -53,7 +53,7 @@ Duration of the audio in seconds, if available format: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1365](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1365) +Defined in: [packages/typescript/ai/src/types.ts:1434](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1434) Audio format of the generated audio @@ -65,7 +65,7 @@ Audio format of the generated audio id: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1359](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1359) +Defined in: [packages/typescript/ai/src/types.ts:1428](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1428) Unique identifier for the generation @@ -77,6 +77,6 @@ Unique identifier for the generation model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1361](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1361) +Defined in: [packages/typescript/ai/src/types.ts:1430](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1430) Model used for generation diff --git a/docs/reference/interfaces/TranscriptionOptions.md b/docs/reference/interfaces/TranscriptionOptions.md index a91271464..32c0a6f74 100644 --- a/docs/reference/interfaces/TranscriptionOptions.md +++ b/docs/reference/interfaces/TranscriptionOptions.md @@ -5,7 +5,7 @@ title: TranscriptionOptions # Interface: TranscriptionOptions\ -Defined in: [packages/typescript/ai/src/types.ts:1380](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1380) +Defined in: [packages/typescript/ai/src/types.ts:1449](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1449) Options for audio transcription. These are the common options supported across providers. @@ -24,7 +24,7 @@ These are the common options supported across providers. audio: string | File | Blob | ArrayBuffer; ``` -Defined in: [packages/typescript/ai/src/types.ts:1386](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1386) +Defined in: [packages/typescript/ai/src/types.ts:1455](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1455) The audio data to transcribe - can be base64 string, File, Blob, or Buffer @@ -36,7 +36,7 @@ The audio data to transcribe - can be base64 string, File, Blob, or Buffer optional language: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1388](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1388) +Defined in: [packages/typescript/ai/src/types.ts:1457](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1457) The language of the audio in ISO-639-1 format (e.g., 'en') @@ -48,7 +48,7 @@ The language of the audio in ISO-639-1 format (e.g., 'en') logger: InternalLogger; ``` -Defined in: [packages/typescript/ai/src/types.ts:1400](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1400) +Defined in: [packages/typescript/ai/src/types.ts:1469](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1469) Internal logger threaded from the generateTranscription() entry point. Adapters must call logger.request() before the SDK call and logger.errors() @@ -62,7 +62,7 @@ in catch blocks. model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1384](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1384) +Defined in: [packages/typescript/ai/src/types.ts:1453](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1453) The model to use for transcription @@ -74,7 +74,7 @@ The model to use for transcription optional modelOptions: TProviderOptions; ``` -Defined in: [packages/typescript/ai/src/types.ts:1394](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1394) +Defined in: [packages/typescript/ai/src/types.ts:1463](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1463) Model-specific options for transcription @@ -86,7 +86,7 @@ Model-specific options for transcription optional prompt: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1390](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1390) +Defined in: [packages/typescript/ai/src/types.ts:1459](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1459) An optional prompt to guide the transcription @@ -98,6 +98,6 @@ An optional prompt to guide the transcription optional responseFormat: "text" | "json" | "srt" | "verbose_json" | "vtt"; ``` -Defined in: [packages/typescript/ai/src/types.ts:1392](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1392) +Defined in: [packages/typescript/ai/src/types.ts:1461](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1461) The format of the transcription output diff --git a/docs/reference/interfaces/TranscriptionResult.md b/docs/reference/interfaces/TranscriptionResult.md index 37b1adf96..338923a46 100644 --- a/docs/reference/interfaces/TranscriptionResult.md +++ b/docs/reference/interfaces/TranscriptionResult.md @@ -5,7 +5,7 @@ title: TranscriptionResult # Interface: TranscriptionResult -Defined in: [packages/typescript/ai/src/types.ts:1436](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1436) +Defined in: [packages/typescript/ai/src/types.ts:1505](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1505) Result of audio transcription. @@ -17,7 +17,7 @@ Result of audio transcription. optional duration: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1446](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1446) +Defined in: [packages/typescript/ai/src/types.ts:1515](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1515) Duration of the audio in seconds @@ -29,7 +29,7 @@ Duration of the audio in seconds id: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1438](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1438) +Defined in: [packages/typescript/ai/src/types.ts:1507](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1507) Unique identifier for the transcription @@ -41,7 +41,7 @@ Unique identifier for the transcription optional language: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1444](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1444) +Defined in: [packages/typescript/ai/src/types.ts:1513](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1513) Language detected or specified @@ -53,7 +53,7 @@ Language detected or specified model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1440](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1440) +Defined in: [packages/typescript/ai/src/types.ts:1509](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1509) Model used for transcription @@ -65,7 +65,7 @@ Model used for transcription optional segments: TranscriptionSegment[]; ``` -Defined in: [packages/typescript/ai/src/types.ts:1448](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1448) +Defined in: [packages/typescript/ai/src/types.ts:1517](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1517) Detailed segments with timing, if available @@ -77,7 +77,7 @@ Detailed segments with timing, if available text: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1442](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1442) +Defined in: [packages/typescript/ai/src/types.ts:1511](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1511) The full transcribed text @@ -89,6 +89,6 @@ The full transcribed text optional words: TranscriptionWord[]; ``` -Defined in: [packages/typescript/ai/src/types.ts:1450](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1450) +Defined in: [packages/typescript/ai/src/types.ts:1519](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1519) Word-level timestamps, if available diff --git a/docs/reference/interfaces/TranscriptionSegment.md b/docs/reference/interfaces/TranscriptionSegment.md index 5d5764aaf..24c0babd9 100644 --- a/docs/reference/interfaces/TranscriptionSegment.md +++ b/docs/reference/interfaces/TranscriptionSegment.md @@ -5,7 +5,7 @@ title: TranscriptionSegment # Interface: TranscriptionSegment -Defined in: [packages/typescript/ai/src/types.ts:1406](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1406) +Defined in: [packages/typescript/ai/src/types.ts:1475](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1475) 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/typescript/ai/src/types.ts:1416](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1416) +Defined in: [packages/typescript/ai/src/types.ts:1485](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1485) Confidence score (0-1), if available @@ -29,7 +29,7 @@ Confidence score (0-1), if available end: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1412](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1412) +Defined in: [packages/typescript/ai/src/types.ts:1481](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1481) End time of the segment in seconds @@ -41,7 +41,7 @@ End time of the segment in seconds id: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1408](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1408) +Defined in: [packages/typescript/ai/src/types.ts:1477](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1477) Unique identifier for the segment @@ -53,7 +53,7 @@ Unique identifier for the segment optional speaker: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1418](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1418) +Defined in: [packages/typescript/ai/src/types.ts:1487](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1487) Speaker identifier, if diarization is enabled @@ -65,7 +65,7 @@ Speaker identifier, if diarization is enabled start: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1410](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1410) +Defined in: [packages/typescript/ai/src/types.ts:1479](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1479) Start time of the segment in seconds @@ -77,6 +77,6 @@ Start time of the segment in seconds text: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1414](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1414) +Defined in: [packages/typescript/ai/src/types.ts:1483](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1483) Transcribed text for this segment diff --git a/docs/reference/interfaces/TranscriptionWord.md b/docs/reference/interfaces/TranscriptionWord.md index 1b035a377..42160b603 100644 --- a/docs/reference/interfaces/TranscriptionWord.md +++ b/docs/reference/interfaces/TranscriptionWord.md @@ -5,7 +5,7 @@ title: TranscriptionWord # Interface: TranscriptionWord -Defined in: [packages/typescript/ai/src/types.ts:1424](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1424) +Defined in: [packages/typescript/ai/src/types.ts:1493](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1493) A single word with timing information. @@ -17,7 +17,7 @@ A single word with timing information. end: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1430](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1430) +Defined in: [packages/typescript/ai/src/types.ts:1499](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1499) End time in seconds @@ -29,7 +29,7 @@ End time in seconds start: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1428](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1428) +Defined in: [packages/typescript/ai/src/types.ts:1497](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1497) Start time in seconds @@ -41,6 +41,6 @@ Start time in seconds word: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1426](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1426) +Defined in: [packages/typescript/ai/src/types.ts:1495](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1495) The transcribed word diff --git a/docs/reference/interfaces/VideoGenerationOptions.md b/docs/reference/interfaces/VideoGenerationOptions.md index 88bcb72ee..6338f0252 100644 --- a/docs/reference/interfaces/VideoGenerationOptions.md +++ b/docs/reference/interfaces/VideoGenerationOptions.md @@ -5,7 +5,7 @@ title: VideoGenerationOptions # Interface: VideoGenerationOptions\ -Defined in: [packages/typescript/ai/src/types.ts:1262](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1262) +Defined in: [packages/typescript/ai/src/types.ts:1331](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1331) **`Experimental`** @@ -32,7 +32,7 @@ These are the common options supported across providers. optional duration: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1273](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1273) +Defined in: [packages/typescript/ai/src/types.ts:1342](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1342) **`Experimental`** @@ -46,7 +46,7 @@ Video duration in seconds logger: InternalLogger; ``` -Defined in: [packages/typescript/ai/src/types.ts:1280](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1280) +Defined in: [packages/typescript/ai/src/types.ts:1349](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1349) **`Experimental`** @@ -61,7 +61,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1267](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1267) +Defined in: [packages/typescript/ai/src/types.ts:1336](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1336) **`Experimental`** @@ -75,7 +75,7 @@ The model to use for video generation optional modelOptions: TProviderOptions; ``` -Defined in: [packages/typescript/ai/src/types.ts:1275](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1275) +Defined in: [packages/typescript/ai/src/types.ts:1344](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1344) **`Experimental`** @@ -89,7 +89,7 @@ Model-specific options for video generation prompt: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1269](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1269) +Defined in: [packages/typescript/ai/src/types.ts:1338](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1338) **`Experimental`** @@ -103,7 +103,7 @@ Text description of the desired video optional size: TSize; ``` -Defined in: [packages/typescript/ai/src/types.ts:1271](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1271) +Defined in: [packages/typescript/ai/src/types.ts:1340](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1340) **`Experimental`** diff --git a/docs/reference/interfaces/VideoJobResult.md b/docs/reference/interfaces/VideoJobResult.md index 09a9518f7..77a7972db 100644 --- a/docs/reference/interfaces/VideoJobResult.md +++ b/docs/reference/interfaces/VideoJobResult.md @@ -5,7 +5,7 @@ title: VideoJobResult # Interface: VideoJobResult -Defined in: [packages/typescript/ai/src/types.ts:1288](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1288) +Defined in: [packages/typescript/ai/src/types.ts:1357](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1357) **`Experimental`** @@ -21,7 +21,7 @@ Result of creating a video generation job. jobId: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1290](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1290) +Defined in: [packages/typescript/ai/src/types.ts:1359](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1359) **`Experimental`** @@ -35,7 +35,7 @@ Unique job identifier for polling status model: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1292](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1292) +Defined in: [packages/typescript/ai/src/types.ts:1361](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1361) **`Experimental`** diff --git a/docs/reference/interfaces/VideoStatusResult.md b/docs/reference/interfaces/VideoStatusResult.md index 522149991..141684b63 100644 --- a/docs/reference/interfaces/VideoStatusResult.md +++ b/docs/reference/interfaces/VideoStatusResult.md @@ -5,7 +5,7 @@ title: VideoStatusResult # Interface: VideoStatusResult -Defined in: [packages/typescript/ai/src/types.ts:1300](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1300) +Defined in: [packages/typescript/ai/src/types.ts:1369](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1369) **`Experimental`** @@ -21,7 +21,7 @@ Status of a video generation job. optional error: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1308](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1308) +Defined in: [packages/typescript/ai/src/types.ts:1377](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1377) **`Experimental`** @@ -35,7 +35,7 @@ Error message if status is 'failed' jobId: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1302](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1302) +Defined in: [packages/typescript/ai/src/types.ts:1371](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1371) **`Experimental`** @@ -49,7 +49,7 @@ Job identifier optional progress: number; ``` -Defined in: [packages/typescript/ai/src/types.ts:1306](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1306) +Defined in: [packages/typescript/ai/src/types.ts:1375](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1375) **`Experimental`** @@ -63,7 +63,7 @@ Progress percentage (0-100), if available status: "pending" | "processing" | "completed" | "failed"; ``` -Defined in: [packages/typescript/ai/src/types.ts:1304](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1304) +Defined in: [packages/typescript/ai/src/types.ts:1373](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1373) **`Experimental`** diff --git a/docs/reference/interfaces/VideoUrlResult.md b/docs/reference/interfaces/VideoUrlResult.md index c2fbca191..c151cd374 100644 --- a/docs/reference/interfaces/VideoUrlResult.md +++ b/docs/reference/interfaces/VideoUrlResult.md @@ -5,7 +5,7 @@ title: VideoUrlResult # Interface: VideoUrlResult -Defined in: [packages/typescript/ai/src/types.ts:1316](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1316) +Defined in: [packages/typescript/ai/src/types.ts:1385](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1385) **`Experimental`** @@ -21,7 +21,7 @@ Result containing the URL to a generated video. optional expiresAt: Date; ``` -Defined in: [packages/typescript/ai/src/types.ts:1322](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1322) +Defined in: [packages/typescript/ai/src/types.ts:1391](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1391) **`Experimental`** @@ -35,7 +35,7 @@ When the URL expires, if applicable jobId: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1318](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1318) +Defined in: [packages/typescript/ai/src/types.ts:1387](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1387) **`Experimental`** @@ -49,7 +49,7 @@ Job identifier url: string; ``` -Defined in: [packages/typescript/ai/src/types.ts:1320](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1320) +Defined in: [packages/typescript/ai/src/types.ts:1389](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1389) **`Experimental`** diff --git a/docs/reference/type-aliases/AIAdapter.md b/docs/reference/type-aliases/AIAdapter.md index aa8f2b895..429e0663e 100644 --- a/docs/reference/type-aliases/AIAdapter.md +++ b/docs/reference/type-aliases/AIAdapter.md @@ -10,11 +10,12 @@ type AIAdapter = | AnyTextAdapter | AnySummarizeAdapter | AnyImageAdapter + | AnyAudioAdapter | AnyVideoAdapter | AnyTTSAdapter | AnyTranscriptionAdapter; ``` -Defined in: [packages/typescript/ai/src/activities/index.ts:149](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/index.ts#L149) +Defined in: [packages/typescript/ai/src/activities/index.ts:169](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/index.ts#L169) Union of all adapter types that can be passed to chat() diff --git a/docs/reference/type-aliases/AnyAudioAdapter.md b/docs/reference/type-aliases/AnyAudioAdapter.md new file mode 100644 index 000000000..040ef8a3a --- /dev/null +++ b/docs/reference/type-aliases/AnyAudioAdapter.md @@ -0,0 +1,15 @@ +--- +id: AnyAudioAdapter +title: AnyAudioAdapter +--- + +# Type Alias: AnyAudioAdapter + +```ts +type AnyAudioAdapter = AudioAdapter; +``` + +Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L54) + +An AudioAdapter with any/unknown type parameters. +Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/GeneratedAudio.md b/docs/reference/type-aliases/GeneratedAudio.md new file mode 100644 index 000000000..1b809308d --- /dev/null +++ b/docs/reference/type-aliases/GeneratedAudio.md @@ -0,0 +1,32 @@ +--- +id: GeneratedAudio +title: GeneratedAudio +--- + +# Type Alias: GeneratedAudio + +```ts +type GeneratedAudio = GeneratedMediaSource & object; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1296](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1296) + +A single generated audio output + +## Type Declaration + +### contentType? + +```ts +optional contentType: string; +``` + +Content type of the audio (e.g., 'audio/wav', 'audio/mp3') + +### duration? + +```ts +optional duration: number; +``` + +Duration of the generated audio in seconds diff --git a/docs/reference/type-aliases/GeneratedImage.md b/docs/reference/type-aliases/GeneratedImage.md new file mode 100644 index 000000000..b1b544cc8 --- /dev/null +++ b/docs/reference/type-aliases/GeneratedImage.md @@ -0,0 +1,24 @@ +--- +id: GeneratedImage +title: GeneratedImage +--- + +# Type Alias: GeneratedImage + +```ts +type GeneratedImage = GeneratedMediaSource & object; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1243](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1243) + +A single generated image + +## Type Declaration + +### revisedPrompt? + +```ts +optional revisedPrompt: string; +``` + +Revised prompt used by the model (if applicable) diff --git a/docs/reference/type-aliases/GeneratedMediaSource.md b/docs/reference/type-aliases/GeneratedMediaSource.md new file mode 100644 index 000000000..f4b924869 --- /dev/null +++ b/docs/reference/type-aliases/GeneratedMediaSource.md @@ -0,0 +1,69 @@ +--- +id: GeneratedMediaSource +title: GeneratedMediaSource +--- + +# Type Alias: GeneratedMediaSource + +```ts +type GeneratedMediaSource = + | { + b64Json?: never; + url: string; +} + | { + b64Json: string; + url?: never; +}; +``` + +Defined in: [packages/typescript/ai/src/types.ts:1228](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1228) + +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 +type rejects `{}` and `{ url, b64Json }` together at compile time while +preserving the flat `.url` / `.b64Json` access patterns. + +## Type Declaration + +```ts +{ + b64Json?: never; + url: string; +} +``` + +### b64Json? + +```ts +optional b64Json: never; +``` + +### url + +```ts +url: string; +``` + +URL to the generated asset (may be temporary) + +```ts +{ + b64Json: string; + url?: never; +} +``` + +### b64Json + +```ts +b64Json: string; +``` + +Base64-encoded asset data + +### url? + +```ts +optional url: never; +```