Skip to content

TranscriptionOptions.md

Latest commit

 

History

History
103 lines (62 loc) · 2.3 KB

TranscriptionOptions.md

File metadata and controls

103 lines (62 loc) · 2.3 KB
id TranscriptionOptions
title TranscriptionOptions

Interface: TranscriptionOptions<TProviderOptions>

Defined in: packages/typescript/ai/src/types.ts:1380

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: packages/typescript/ai/src/types.ts:1386

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

language?

optional language: string;

Defined in: packages/typescript/ai/src/types.ts:1388

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

logger

logger: InternalLogger;

Defined in: packages/typescript/ai/src/types.ts:1400

Internal logger threaded from the generateTranscription() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.

model

model: string;

Defined in: packages/typescript/ai/src/types.ts:1384

The model to use for transcription

modelOptions?

optional modelOptions: TProviderOptions;

Defined in: packages/typescript/ai/src/types.ts:1394

Model-specific options for transcription

prompt?

optional prompt: string;

Defined in: packages/typescript/ai/src/types.ts:1390

An optional prompt to guide the transcription

responseFormat?

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

Defined in: packages/typescript/ai/src/types.ts:1392

The format of the transcription output