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

TranscriptionOptions.md

89 lines1.8 KB

Interface: TranscriptionOptions<TProviderOptions>

Defined in: types.ts:932

Options for audio transcription. These are the common options supported across providers.

Type Parameters

TProviderOptions

TProviderOptions extends object = object

Properties

audio

audio: string | File | Blob | ArrayBuffer;

Defined in: types.ts:938

The audio data to transcribe - can be base64 string, File, Blob, or Buffer


language?

optional language: string;

Defined in: types.ts:940

The language of the audio in ISO-639-1 format (e.g., 'en')


model

model: string;

Defined in: types.ts:936

The model to use for transcription


modelOptions?

optional modelOptions: TProviderOptions;

Defined in: types.ts:946

Model-specific options for transcription


prompt?

optional prompt: string;

Defined in: types.ts:942

An optional prompt to guide the transcription


responseFormat?

optional responseFormat: "text" | "json" | "srt" | "verbose_json" | "vtt";

Defined in: types.ts:944

The format of the transcription output