Package org.springframework.ai.openai.api

Record Class OpenAiAudioApi.TranscriptionRequest

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiAudioApi.TranscriptionRequest
Record Components:
file - The audio file to transcribe. Must be a valid audio file type.
fileName - The audio file name.
model - ID of the model to use. Only whisper-1 is currently available.
language - The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.
prompt - An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.
responseFormat - The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. Defaults to json.
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.
granularityType - The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.
Enclosing class:
OpenAiAudioApi
public static record OpenAiAudioApi.TranscriptionRequest(byte[] file, String fileName, String model, String language, String prompt, OpenAiAudioApi.TranscriptResponseFormat responseFormat, Float temperature, OpenAiAudioApi.TranscriptionRequest.GranularityType granularityType) extends Record
Request to transcribe an audio file to text. Reference: Create Transcription

  • Constructor Details

  • Method Details

    • builder

      public static OpenAiAudioApi.TranscriptionRequest.Builder builder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • file

      public byte[] file()
      Returns the value of the file record component.
      Returns:
      the value of the file record component

    • fileName

      public String fileName()
      Returns the value of the fileName record component.
      Returns:
      the value of the fileName record component

    • model

      public String model()
      Returns the value of the model record component.
      Returns:
      the value of the model record component

    • language

      public String language()
      Returns the value of the language record component.
      Returns:
      the value of the language record component

    • prompt

      public String prompt()
      Returns the value of the prompt record component.
      Returns:
      the value of the prompt record component

    • responseFormat

      public OpenAiAudioApi.TranscriptResponseFormat responseFormat()
      Returns the value of the responseFormat record component.
      Returns:
      the value of the responseFormat record component

    • temperature

      public Float temperature()
      Returns the value of the temperature record component.
      Returns:
      the value of the temperature record component

    • granularityType

      public OpenAiAudioApi.TranscriptionRequest.GranularityType granularityType()
      Returns the value of the granularityType record component.
      Returns:
      the value of the granularityType record component