Share via


TranscriptionOptions Class

Definition

Metadata for a transcription request.

public class TranscriptionOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.Speech.Transcription.TranscriptionOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Speech.Transcription.TranscriptionOptions>
type TranscriptionOptions = class
    interface IJsonModel<TranscriptionOptions>
    interface IPersistableModel<TranscriptionOptions>
Public Class TranscriptionOptions
Implements IJsonModel(Of TranscriptionOptions), IPersistableModel(Of TranscriptionOptions)
Inheritance
TranscriptionOptions
Implements

Constructors

Name Description
TranscriptionOptions()

Initializes a new instance of TranscriptionOptions.

TranscriptionOptions(Stream)

Initializes a new instance of TranscriptionOptions with an audio stream.

TranscriptionOptions(Uri)

Initializes a new instance of TranscriptionOptions with an audio URI.

Properties

Name Description
ActiveChannels

The 0-based indices of the channels to be transcribed separately. If not specified, multiple channels are merged and transcribed jointly. Only up to two channels are supported.

AudioUri

The URL of the audio to be transcribed. The audio must be shorter than 2 hours in audio duration and smaller than 250 MB in size. If both Audio and AudioUrl are provided, Audio is used.

DiarizationOptions

Mode of diarization.

EnhancedMode

Enhanced mode properties.

Locales

A list of possible locales for the transcription. If not specified, the locale of the speech in the audio is detected automatically from all supported locales.

Models

Maps some or all candidate locales to a model URI to be used for transcription. If no mapping is given, the default model for the locale is used.

PhraseList

Phrase list properties.

ProfanityFilterMode

Mode of profanity filtering.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<TranscriptionOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<TranscriptionOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<TranscriptionOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<TranscriptionOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<TranscriptionOptions>.Write(ModelReaderWriterOptions)

Applies to