Package com.azure.ai.openai.models

Class AudioTranslation

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static AudioTranslation
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AudioTranslation from the JsonReader.
    Duration
    getDuration()
    Get the duration property: The total duration of the audio processed to produce accompanying translation information.
    String
    getLanguage()
    Get the language property: The spoken language that was detected in the translated audio data.
    List<AudioTranslationSegment>
    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 translated text for the provided audio data.
    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

  • Method Details

    • getText

      public String getText()
      Get the text property: The translated 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 translated 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 translation information.
      Returns:
      the duration value.

    • getSegments

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

    • toJson

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

    • fromJson

      public static AudioTranslation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AudioTranslation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AudioTranslation 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 AudioTranslation.