Open History to see the last commit
1---
2id: TranscriptionOptions
3title: TranscriptionOptions
4---
5
6# Interface: TranscriptionOptions\<TProviderOptions\>
7
8Defined in: [packages/typescript/ai/src/types.ts:1664](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1664)
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: [packages/typescript/ai/src/types.ts:1670](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1670)
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: [packages/typescript/ai/src/types.ts:1672](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1672)
40
41The language of the audio in ISO-639-1 format (e.g., 'en')
42
43***
44
45### logger
46
47```ts
48logger: InternalLogger;
49```
50
51Defined in: [packages/typescript/ai/src/types.ts:1684](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1684)
52
53Internal logger threaded from the generateTranscription() entry point.
54Adapters must call logger.request() before the SDK call and logger.errors()
55in catch blocks.
56
57***
58
59### model
60
61```ts
62model: string;
63```
64
65Defined in: [packages/typescript/ai/src/types.ts:1668](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1668)
66
67The model to use for transcription
68
69***
70
71### modelOptions?
72
73```ts
74optional modelOptions: TProviderOptions;
75```
76
77Defined in: [packages/typescript/ai/src/types.ts:1678](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1678)
78
79Model-specific options for transcription
80
81***
82
83### prompt?
84
85```ts
86optional prompt: string;
87```
88
89Defined in: [packages/typescript/ai/src/types.ts:1674](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1674)
90
91An optional prompt to guide the transcription
92
93***
94
95### responseFormat?
96
97```ts
98optional responseFormat: "text" | "json" | "srt" | "verbose_json" | "vtt";
99```
100
101Defined in: [packages/typescript/ai/src/types.ts:1676](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L1676)
102
103The format of the transcription output