Package com.azure.ai.openai.models

Class AudioTranscription

java.lang.Object
com.azure.ai.openai.models.AudioTranscription
All Implemented Interfaces:
com.azure.json.JsonSerializable<AudioTranscription>
public final class AudioTranscription extends Object implements com.azure.json.JsonSerializable<AudioTranscription>
Result information for an operation that transcribed spoken audio into written text.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AudioTranscription
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getText

      public String getText()
      Get the text property: The transcribed text for the provided audio data.
      Returns:
      the text 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.

    • 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.

    • getDuration

      public Duration getDuration()
      Get the duration property: The total duration of the audio processed to produce accompanying transcription information.
      Returns:
      the duration value.

    • getSegments

      public List<AudioTranscriptionSegment> 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.

    • getWords

      public List<AudioTranscriptionWord> getWords()
      Get the words property: A collection of information about the timing of each processed word.
      Returns:
      the words value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AudioTranscription>
      Throws:
      IOException

    • fromJson

      public static AudioTranscription fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AudioTranscription.