Share via

AudioTranscription Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.AudioTranscription

Implements

JsonSerializable<AudioTranscription>

public final class AudioTranscription
implements JsonSerializable<AudioTranscription>

Result information for an operation that transcribed spoken audio into written text.

Method Summary

Modifier and Type Method and Description
static AudioTranscription fromJson(JsonReader jsonReader)

Reads an instance of AudioTranscription from the JsonReader.
Duration getDuration()

Get the duration property: The total duration of the audio processed to produce accompanying transcription information.
String getLanguage()

Get the language property: The spoken language that was detected in the transcribed audio data.
List<AudioTranscriptionSegment> getSegments()

Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment.
AudioTaskLabel getTask()

Get the task property: The label that describes which operation type generated the accompanying response data.
String getText()

Get the text property: The transcribed text for the provided audio data.
List<AudioTranscriptionWord> getWords()

Get the words property: A collection of information about the timing of each processed word.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AudioTranscription fromJson(JsonReader jsonReader)

Reads an instance of AudioTranscription from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AudioTranscription if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getDuration

public Duration getDuration()

Get the duration property: The total duration of the audio processed to produce accompanying transcription information.

Returns:

the duration value.

getLanguage

public String getLanguage()

Get the language property: The spoken language that was detected in the transcribed audio data. This is expressed as a two-letter ISO-639-1 language code like 'en' or 'fr'.

Returns:

the language value.

getSegments

public List getSegments()

Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment.

Returns:

the segments value.

getTask

public AudioTaskLabel getTask()

Get the task property: The label that describes which operation type generated the accompanying response data.

Returns:

the task value.

getText

public String getText()

Get the text property: The transcribed text for the provided audio data.

Returns:

the text value.

getWords

public List getWords()

Get the words property: A collection of information about the timing of each processed word.

Returns:

the words value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to