Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/reference/functions/createAudioOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: createAudioOptions
title: createAudioOptions
---

# Function: createAudioOptions()

```ts
function createAudioOptions<TAdapter, TStream>(options): AudioActivityOptions<TAdapter, TStream>;
```

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`\>
4 changes: 2 additions & 2 deletions docs/reference/functions/createSpeechOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ title: createSpeechOptions
function createSpeechOptions<TAdapter, TStream>(options): TTSActivityOptions<TAdapter, TStream>;
```

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.

## Type Parameters

### TAdapter

`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `object`\>
`TAdapter` *extends* [`TTSAdapter`](../interfaces/TTSAdapter.md)\<`string`, `TTSProviderOptions`\<`TAdapter`\>\>

### TStream

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/functions/createTranscriptionOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ title: createTranscriptionOptions
function createTranscriptionOptions<TAdapter, TStream>(options): TranscriptionActivityOptions<TAdapter, TStream>;
```

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.

## Type Parameters

### TAdapter

`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `object`\>
`TAdapter` *extends* [`TranscriptionAdapter`](../interfaces/TranscriptionAdapter.md)\<`string`, `TranscriptionProviderOptions`\<`TAdapter`\>\>

### TStream

Expand Down
51 changes: 51 additions & 0 deletions docs/reference/functions/generateAudio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
id: generateAudio
title: generateAudio
---

# Function: generateAudio()

```ts
function generateAudio<TAdapter, TStream>(options): AudioActivityResult<TStream>;
```

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
```
2 changes: 1 addition & 1 deletion docs/reference/functions/generateSpeech.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/functions/generateTranscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateTranscription
function generateTranscription<TAdapter, TStream>(options): TranscriptionActivityResult<TStream>;
```

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.

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/generateVideo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: generateVideo
function generateVideo<TAdapter, TStream>(options): TStream extends true ? AsyncIterable<AGUIEvent, any, any> : Promise<VideoJobResult>;
```

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`**

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/streamToText.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: streamToText
function streamToText(stream): Promise<string>;
```

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/toHttpResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/toHttpStream.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: toHttpStream
function toHttpStream(stream, abortController?): ReadableStream<Uint8Array<ArrayBufferLike>>;
```

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)

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/toServerSentEventsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/toServerSentEventsStream.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: toServerSentEventsStream
function toServerSentEventsStream(stream, abortController?): ReadableStream<Uint8Array<ArrayBufferLike>>;
```

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

Expand Down
10 changes: 9 additions & 1 deletion docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
105 changes: 105 additions & 0 deletions docs/reference/interfaces/AudioAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
id: AudioAdapter
title: AudioAdapter
---

# Interface: AudioAdapter\<TModel, TProviderOptions\>

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<AudioGenerationResult>;
```

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
Loading