Interface: TranscriptionOptions<TProviderOptions>#

Defined in: packages/ai/src/types.ts:2293

Type Parameters#

TProviderOptions#

TProviderOptions extends object = object

Properties#

abortSignal?#

optional abortSignal?: AbortSignal;

Defined in: packages/ai/src/types.ts:2319

Effective abort signal composed by the activity from caller abortSignal and/or timeout. Adapters should forward this to the provider SDK when supported. Request-specific — never store on a global client config.

audio#

audio: string | ArrayBuffer | File | Blob;

Defined in: packages/ai/src/types.ts:2299

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

language?#

optional language?: string;

Defined in: packages/ai/src/types.ts:2301

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

logger#

logger: InternalLogger;

Defined in: packages/ai/src/types.ts:2313

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/ai/src/types.ts:2297

The model to use for transcription

modelOptions?#

optional modelOptions?: TProviderOptions;

Defined in: packages/ai/src/types.ts:2307

Model-specific options for transcription

prompt?#

optional prompt?: string;

Defined in: packages/ai/src/types.ts:2303

An optional prompt to guide the transcription

responseFormat?#

optional responseFormat?: TranscriptionResponseFormat;

Defined in: packages/ai/src/types.ts:2305

The format of the transcription output