AudioTranscriptionOptions Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: AudioTranscriptionOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The configuration information for an audio transcription request.

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

type AudioTranscriptionOptions = class
    interface IJsonModel<AudioTranscriptionOptions>
    interface IPersistableModel<AudioTranscriptionOptions>

Public Class AudioTranscriptionOptions
Implements IJsonModel(Of AudioTranscriptionOptions), IPersistableModel(Of AudioTranscriptionOptions)

Inheritance: Object
AudioTranscriptionOptions

Implements: IJsonModel<AudioTranscriptionOptions> IPersistableModel<AudioTranscriptionOptions> IPersistableModel<T>

Constructors

AudioTranscriptionOptions()	Initializes a new instance of AudioTranscriptionOptions.
AudioTranscriptionOptions(String, BinaryData)	Initializes a new instance of AudioTranscriptionOptions.

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 FromBytes(Byte[]). The byte[] will be serialized to a Base64 encoded string. Examples: BinaryData.FromBytes(new byte[] { 1, 2, 3 }): Creates a payload of "AQID".
DeploymentName	The deployment name to use for audio transcription.
Filename	The optional filename or descriptive identifier to associate with with the audio data.
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.
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.
ResponseFormat	The requested format of the transcription response data, which will influence the content and detail of the result.
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.
TimestampGranularityFlags	The bitwise-aggregated timestamp granularity types that should be requested on an audio transcription operation.

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.
IJsonModel<AudioTranscriptionOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AudioTranscriptionOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AudioTranscriptionOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AudioTranscriptionOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to