Share via


OpenAIClient.GetAudioTranscriptionAsync Method

Definition

Transcribes audio into the input language.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.AudioTranscription>> GetAudioTranscriptionAsync (Azure.AI.OpenAI.AudioTranscriptionOptions audioTranscriptionOptions, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAudioTranscriptionAsync : Azure.AI.OpenAI.AudioTranscriptionOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.AudioTranscription>>
override this.GetAudioTranscriptionAsync : Azure.AI.OpenAI.AudioTranscriptionOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.AudioTranscription>>
Public Overridable Function GetAudioTranscriptionAsync (audioTranscriptionOptions As AudioTranscriptionOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AudioTranscription))

Parameters

audioTranscriptionOptions
AudioTranscriptionOptions

Transcription request. Requesting format 'json' will result on only the 'text' field being set. For more output data use 'verbose_json.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

audioTranscriptionOptions or audioTranscriptionOptions.DeploymentName.DeploymentName is null.

audioTranscriptionOptions.DeploymentName.DeploymentName is an empty string.

Applies to