TanStack

TranscriptionAdapter

Interface: TranscriptionAdapter<TModel, TProviderOptions>

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:24

Transcription adapter interface with pre-resolved generics.

An adapter is created by a provider function: provider('model')adapter All type resolution happens at the provider call site, not in this interface.

Generic parameters:

  • TModel: The specific model name (e.g., 'whisper-1')
  • TProviderOptions: Provider-specific options (already resolved)

Type Parameters

TModel

TModel extends string = string

TProviderOptions

TProviderOptions extends object = Record<string, unknown>

Properties

~types

ts
~types: object;

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:38

Internal

Type-only properties for inference. Not assigned at runtime.

providerOptions

ts
providerOptions: TProviderOptions;

kind

ts
readonly kind: "transcription";

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:29

Discriminator for adapter kind - used to determine API shape


model

ts
readonly model: TModel;

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:33

The model this adapter is configured for


name

ts
readonly name: string;

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:31

Adapter name identifier


transcribe()

ts
transcribe: (options) => Promise<TranscriptionResult>;

Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:45

Transcribe audio to text

Parameters

options

TranscriptionOptions<TProviderOptions>

Returns

Promise<TranscriptionResult>