OpenAITranscriptionModel

Namespace: Vercel.AI.OpenAI

public sealed class OpenAITranscriptionModel : ITranscriptionModel

OpenAI audio transcription model.

Inheritance: object

Implements: ITranscriptionModel

View source

Constructors

OpenAITranscriptionModel(OpenAIProvider, string, Func<DateTimeOffset>?)

public OpenAITranscriptionModel(OpenAIProvider provider, string modelId, Func<DateTimeOffset>? clock = null)

Creates a transcription model. <code class=“paramref”>clock</code> sets the response timestamp and defaults to UTC now.

Parameters

Name	Type	Description
provider	OpenAIProvider
modelId	string
clock	Func<DateTimeOffset>

View source

OpenAITranscriptionModel(OpenAIProvider, string, string, Func<DateTimeOffset>?)

public OpenAITranscriptionModel(OpenAIProvider provider, string modelId, string path, Func<DateTimeOffset>? clock = null)

Creates a transcription or translation model for <code class=“paramref”>path</code>.

Parameters

Name	Type	Description
provider	OpenAIProvider
modelId	string
path	string
clock	Func<DateTimeOffset>

View source

Properties

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

Methods

Build(OpenAITranscriptionCall)

public MultipartFormDataContent Build(OpenAITranscriptionCall call)

Builds the multipart body so tests can inspect field names.

Parameters

Name	Type	Description
call	OpenAITranscriptionCall

Returns: MultipartFormDataContent

View source

DoTranscribeAsync(AudioInput, CancellationToken)

public Task<TranscriptionResult> DoTranscribeAsync(AudioInput audio, CancellationToken cancellationToken)

Transcribes audio.

Parameters

Name	Type	Description
audio	AudioInput
cancellationToken	CancellationToken

Returns: Task<TranscriptionResult>

View source

IsRealtimeWhisper(string)

public static bool IsRealtimeWhisper(string modelId)

True when <code class=“paramref”>modelId</code> must use the realtime transcription socket.

Parameters

Name	Type	Description
modelId	string

Returns: bool

View source

TranscribeAsync(OpenAITranscriptionCall, CancellationToken)

public Task<OpenAITranscriptionResult> TranscribeAsync(OpenAITranscriptionCall call, CancellationToken cancellationToken)

Transcribes audio and returns segments, language, duration, and response metadata.

Parameters

Name	Type	Description
call	OpenAITranscriptionCall
cancellationToken	CancellationToken

Returns: Task<OpenAITranscriptionResult>

View source