Constructor Detail

Method Detail

• file

   final InputStream file()

  The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

• model

   final AudioModel model()

  ID of the model to use. The options are gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1 (which is powered by our open source Whisper V2 model), and gpt-4o-transcribe-diarize.

• chunkingStrategy

   final Optional<TranscriptionCreateParams.ChunkingStrategy> chunkingStrategy()

  Controls how the audio is cut into chunks. When set to "auto", the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. server_vad object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block. Required when using gpt-4o-transcribe-diarize for inputs longer than 30 seconds.

• include

   final Optional<List<TranscriptionInclude>> include()

  Additional information to include in the transcription response. logprobs will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. logprobs only works with response_format set to json and only with the models gpt-4o-transcribe, gpt-4o-mini-transcribe, and gpt-4o-mini-transcribe-2025-12-15. This field is not supported when using gpt-4o-transcribe-diarize.

• knownSpeakerNames

   final Optional<List<String>> knownSpeakerNames()

  Optional list of speaker names that correspond to the audio samples provided in known_speaker_references[]. Each entry should be a short identifier (for example customer or agent). Up to 4 speakers are supported.

• knownSpeakerReferences

   final Optional<List<String>> knownSpeakerReferences()

  Optional list of audio samples (as data URLs) that contain known speaker references matching known_speaker_names[]. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by file.

• language

   final Optional<String> language()

  The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

• prompt

   final Optional<String> prompt()

  An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. This field is not supported when using gpt-4o-transcribe-diarize.

• responseFormat

   final Optional<AudioResponseFormat> responseFormat()

  The format of the output, in one of these options: json, text, srt, verbose_json, vtt, or diarized_json. For gpt-4o-transcribe and gpt-4o-mini-transcribe, the only supported format is json. For gpt-4o-transcribe-diarize, the supported formats are json, text, and diarized_json, with diarized_json required to receive speaker annotations.

• temperature

   final Optional<Double> 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.

• timestampGranularities

   final Optional<List<TranscriptionCreateParams.TimestampGranularity>> timestampGranularities()

  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. This option is not available for gpt-4o-transcribe-diarize.

• _file

   final MultipartField<InputStream> _file()

  Returns the raw multipart value of file.

  Unlike file, this method doesn't throw if the multipart field has an unexpected type.

• _model

   final MultipartField<AudioModel> _model()

  Returns the raw multipart value of model.

  Unlike model, this method doesn't throw if the multipart field has an unexpected type.

• _chunkingStrategy

   final MultipartField<TranscriptionCreateParams.ChunkingStrategy> _chunkingStrategy()

  Returns the raw multipart value of chunkingStrategy.

  Unlike chunkingStrategy, this method doesn't throw if the multipart field has an unexpected type.

• _include

   final MultipartField<List<TranscriptionInclude>> _include()

  Returns the raw multipart value of include.

  Unlike include, this method doesn't throw if the multipart field has an unexpected type.

• _knownSpeakerNames

   final MultipartField<List<String>> _knownSpeakerNames()

  Returns the raw multipart value of knownSpeakerNames.

  Unlike knownSpeakerNames, this method doesn't throw if the multipart field has an unexpected type.

• _knownSpeakerReferences

   final MultipartField<List<String>> _knownSpeakerReferences()

  Returns the raw multipart value of knownSpeakerReferences.

  Unlike knownSpeakerReferences, this method doesn't throw if the multipart field has an unexpected type.

• _language

   final MultipartField<String> _language()

  Returns the raw multipart value of language.

  Unlike language, this method doesn't throw if the multipart field has an unexpected type.

• _prompt

   final MultipartField<String> _prompt()

  Returns the raw multipart value of prompt.

  Unlike prompt, this method doesn't throw if the multipart field has an unexpected type.

• _responseFormat

   final MultipartField<AudioResponseFormat> _responseFormat()

  Returns the raw multipart value of responseFormat.

  Unlike responseFormat, this method doesn't throw if the multipart field has an unexpected type.

• _temperature

   final MultipartField<Double> _temperature()

  Returns the raw multipart value of temperature.

  Unlike temperature, this method doesn't throw if the multipart field has an unexpected type.

• _timestampGranularities

   final MultipartField<List<TranscriptionCreateParams.TimestampGranularity>> _timestampGranularities()

  Returns the raw multipart value of timestampGranularities.

  Unlike timestampGranularities, this method doesn't throw if the multipart field has an unexpected type.

• _additionalBodyProperties

   final Map<String, JsonValue> _additionalBodyProperties()

• _additionalHeaders

   final Headers _additionalHeaders()

  Additional headers to send with the request.

• _additionalQueryParams

   final QueryParams _additionalQueryParams()

  Additional query param to send with the request.

• toBuilder

   final TranscriptionCreateParams.Builder toBuilder()

• _body

   final Map<String, MultipartField<?>> _body()

• _headers

   Headers _headers()

  The full set of headers in the parameters, including both fixed and additional headers.

• _queryParams

   QueryParams _queryParams()

  The full set of query params in the parameters, including both fixed and additional query params.

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static TranscriptionCreateParams.Builder builder()

  Returns a mutable builder for constructing an instance of TranscriptionCreateParams.

  The following fields are required:

  .file()
  .model()