Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

TranscriptionOptions.md

89 lines1.8 KB

1---
2id: TranscriptionOptions
3title: TranscriptionOptions
4---
5​
6# Interface: TranscriptionOptions\<TProviderOptions\>
7​
8Defined in: [types.ts:932](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L932)
9​
10Options for audio transcription.
11These are the common options supported across providers.
12​
13## Type Parameters
14​
15### TProviderOptions
16​
17`TProviderOptions` *extends* `object` = `object`
18​
19## Properties
20​
21### audio
22​
23```ts
24audio: string | File | Blob | ArrayBuffer;
25```
26​
27Defined in: [types.ts:938](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L938)
28​
29The audio data to transcribe - can be base64 string, File, Blob, or Buffer
30​
31***
32​
33### language?
34​
35```ts
36optional language: string;
37```
38​
39Defined in: [types.ts:940](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L940)
40​
41The language of the audio in ISO-639-1 format (e.g., 'en')
42​
43***
44​
45### model
46​
47```ts
48model: string;
49```
50​
51Defined in: [types.ts:936](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L936)
52​
53The model to use for transcription
54​
55***
56​
57### modelOptions?
58​
59```ts
60optional modelOptions: TProviderOptions;
61```
62​
63Defined in: [types.ts:946](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L946)
64​
65Model-specific options for transcription
66​
67***
68​
69### prompt?
70​
71```ts
72optional prompt: string;
73```
74​
75Defined in: [types.ts:942](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L942)
76​
77An optional prompt to guide the transcription
78​
79***
80​
81### responseFormat?
82​
83```ts
84optional responseFormat: "text" | "json" | "srt" | "verbose_json" | "vtt";
85```
86​
87Defined in: [types.ts:944](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L944)
88​
89The format of the transcription output