Class AudioTranscriptionOptions | Azure SDK for .NET

The configuration information for an audio transcription request.

Inheritance

System.Object

AudioTranscriptionOptions

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

public class AudioTranscriptionOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.AudioTranscriptionOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.AudioTranscriptionOptions>

Constructors

AudioTranscriptionOptions()

Declaration

public AudioTranscriptionOptions ();

AudioTranscriptionOptions(String, BinaryData)

Declaration

public AudioTranscriptionOptions (string deploymentName, BinaryData audioData);

Parameters

Exceptions

Properties

AudioData

The audio data to transcribe. This must be the binary content of a file in one of the supported media formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.

To assign a byte[] to this property use System.BinaryData.FromBytes(System.Byte[]). The byte[] will be serialized to a Base64 encoded string.

Examples:

• BinaryData.FromBytes(new byte[] { 1, 2, 3 })Creates a payload of "AQID".

Declaration

public BinaryData AudioData { get; set; }

Property Value

DeploymentName

The deployment name to use for audio transcription.

Declaration

public string DeploymentName { get; set; }

Property Value

Filename

The optional filename or descriptive identifier to associate with with the audio data.

Declaration

public string Filename { get; set; }

Property Value

Language

The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code such as 'en' or 'fr'. Providing this known input language is optional but may improve the accuracy and/or latency of transcription.

Declaration

public string Language { get; set; }

Property Value

Prompt

An optional hint to guide the model's style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data.

Declaration

public string Prompt { get; set; }

Property Value

ResponseFormat

The requested format of the transcription response data, which will influence the content and detail of the result.

Declaration

public Nullable<Azure.AI.OpenAI.AudioTranscriptionFormat> ResponseFormat { get; set; }

Property Value

Temperature

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Declaration

public Nullable<float> Temperature { get; set; }

Property Value

Explicit Interface Implementations

IJsonModel<AudioTranscriptionOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration

Azure.AI.OpenAI.AudioTranscriptionOptions IJsonModel<AudioTranscriptionOptions>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

Returns

Exceptions

IJsonModel<AudioTranscriptionOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<AudioTranscriptionOptions>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

Exceptions

IPersistableModel<AudioTranscriptionOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.AI.OpenAI.AudioTranscriptionOptions IPersistableModel<AudioTranscriptionOptions>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

Returns

Exceptions

IPersistableModel<AudioTranscriptionOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

string IPersistableModel<AudioTranscriptionOptions>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

Returns

IPersistableModel<AudioTranscriptionOptions>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<AudioTranscriptionOptions>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

Returns

Exceptions

ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnplonJ%2Bpu6bAjnqxrqqVY46Keq6pnKd5eWR%2Bb3yNaWSbnaSWe3KBjpqnomdxr8KzsY16gGeHoJq7gpWOerGuqpVjjop6rqmcp3l5Y462sMioi6uZnqiws7XPraCopn%2Blwaq7zaxloaydoQ%3D%3D