Skip to content

Commit ff33855

Browse files
docs: regenerate API documentation (#507)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent af19dcc commit ff33855

34 files changed

Lines changed: 581 additions & 133 deletions
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
id: createAudioOptions
3+
title: createAudioOptions
4+
---
5+
6+
# Function: createAudioOptions()
7+
8+
```ts
9+
function createAudioOptions<TAdapter, TStream>(options): AudioActivityOptions<TAdapter, TStream>;
10+
```
11+
12+
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)
13+
14+
Create typed options for the generateAudio() function without executing.
15+
16+
## Type Parameters
17+
18+
### TAdapter
19+
20+
`TAdapter` *extends* [`AudioAdapter`](../interfaces/AudioAdapter.md)\<`string`, `AudioProviderOptions`\<`TAdapter`\>\>
21+
22+
### TStream
23+
24+
`TStream` *extends* `boolean` = `false`
25+
26+
## Parameters
27+
28+
### options
29+
30+
`AudioActivityOptions`\<`TAdapter`, `TStream`\>
31+
32+
## Returns
33+
34+
`AudioActivityOptions`\<`TAdapter`, `TStream`\>

docs/reference/functions/createSpeechOptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ title: createSpeechOptions
99
function createSpeechOptions<TAdapter, TStream>(options): TTSActivityOptions<TAdapter, TStream>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Create typed options for the generateSpeech() function without executing.
1515

1616
## Type Parameters
1717

1818
### TAdapter
1919

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

2222
### TStream
2323

docs/reference/functions/createTranscriptionOptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ title: createTranscriptionOptions
99
function createTranscriptionOptions<TAdapter, TStream>(options): TranscriptionActivityOptions<TAdapter, TStream>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Create typed options for the generateTranscription() function without executing.
1515

1616
## Type Parameters
1717

1818
### TAdapter
1919

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

2222
### TStream
2323

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
id: generateAudio
3+
title: generateAudio
4+
---
5+
6+
# Function: generateAudio()
7+
8+
```ts
9+
function generateAudio<TAdapter, TStream>(options): AudioActivityResult<TStream>;
10+
```
11+
12+
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)
13+
14+
Audio generation activity - generates audio from text prompts.
15+
16+
Uses AI models to create music, sound effects, and other audio content.
17+
18+
## Type Parameters
19+
20+
### TAdapter
21+
22+
`TAdapter` *extends* [`AudioAdapter`](../interfaces/AudioAdapter.md)\<`string`, `AudioProviderOptions`\<`TAdapter`\>\>
23+
24+
### TStream
25+
26+
`TStream` *extends* `boolean` = `false`
27+
28+
## Parameters
29+
30+
### options
31+
32+
`AudioActivityOptions`\<`TAdapter`, `TStream`\>
33+
34+
## Returns
35+
36+
`AudioActivityResult`\<`TStream`\>
37+
38+
## Example
39+
40+
```ts
41+
import { generateAudio } from '@tanstack/ai'
42+
import { falAudio } from '@tanstack/ai-fal'
43+
44+
const result = await generateAudio({
45+
adapter: falAudio('fal-ai/diffrhythm'),
46+
prompt: 'An upbeat electronic track with synths',
47+
duration: 10
48+
})
49+
50+
console.log(result.audio.url) // URL to generated audio
51+
```

docs/reference/functions/generateSpeech.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Uses AI text-to-speech models to create audio from natural language text.
1919

2020
### TAdapter
2121

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

2424
### TStream
2525

docs/reference/functions/generateTranscription.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: generateTranscription
99
function generateTranscription<TAdapter, TStream>(options): TranscriptionActivityResult<TStream>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Transcription activity - converts audio to text.
1515

@@ -19,7 +19,7 @@ Uses AI speech-to-text models to transcribe audio content.
1919

2020
### TAdapter
2121

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

2424
### TStream
2525

docs/reference/functions/generateVideo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: generateVideo
99
function generateVideo<TAdapter, TStream>(options): TStream extends true ? AsyncIterable<AGUIEvent, any, any> : Promise<VideoJobResult>;
1010
```
1111

12-
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)
12+
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)
1313

1414
**`Experimental`**
1515

docs/reference/functions/streamToText.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: streamToText
99
function streamToText(stream): Promise<string>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Collect all text content from a StreamChunk async iterable and return as a string.
1515

docs/reference/functions/toHttpResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: toHttpResponse
99
function toHttpResponse(stream, init?): Response;
1010
```
1111

12-
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)
12+
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)
1313

1414
Convert a StreamChunk async iterable to a Response in HTTP stream format (newline-delimited JSON)
1515

docs/reference/functions/toHttpStream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: toHttpStream
99
function toHttpStream(stream, abortController?): ReadableStream<Uint8Array<ArrayBufferLike>>;
1010
```
1111

12-
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)
12+
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)
1313

1414
Convert a StreamChunk async iterable to a ReadableStream in HTTP stream format (newline-delimited JSON)
1515

0 commit comments

Comments
 (0)