Constructor Detail

Method Detail

• format

   final RealtimeTranscriptionSessionAudioInput.Builder format(RealtimeAudioFormats format)

  The PCM audio format. Only a 24kHz sample rate is supported.

• format

   final RealtimeTranscriptionSessionAudioInput.Builder format(JsonField<RealtimeAudioFormats> format)

  Sets Builder.format to an arbitrary JSON value.

  You should usually call Builder.format with a well-typed RealtimeAudioFormats value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• format

   final RealtimeTranscriptionSessionAudioInput.Builder format(RealtimeAudioFormats.AudioPcm audioPcm)

  Alias for calling format with RealtimeAudioFormats.ofAudioPcm(audioPcm).

• format

   final RealtimeTranscriptionSessionAudioInput.Builder format(RealtimeAudioFormats.AudioPcmu audioPcmu)

  Alias for calling format with RealtimeAudioFormats.ofAudioPcmu(audioPcmu).

• format

   final RealtimeTranscriptionSessionAudioInput.Builder format(RealtimeAudioFormats.AudioPcma audioPcma)

  Alias for calling format with RealtimeAudioFormats.ofAudioPcma(audioPcma).

• noiseReduction

   final RealtimeTranscriptionSessionAudioInput.Builder noiseReduction(RealtimeTranscriptionSessionAudioInput.NoiseReduction noiseReduction)

  Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

• noiseReduction

   final RealtimeTranscriptionSessionAudioInput.Builder noiseReduction(JsonField<RealtimeTranscriptionSessionAudioInput.NoiseReduction> noiseReduction)

  Sets Builder.noiseReduction to an arbitrary JSON value.

  You should usually call Builder.noiseReduction with a well-typed NoiseReduction value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• transcription

   final RealtimeTranscriptionSessionAudioInput.Builder transcription(AudioTranscription transcription)

  Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

• transcription

   final RealtimeTranscriptionSessionAudioInput.Builder transcription(JsonField<AudioTranscription> transcription)

  Sets Builder.transcription to an arbitrary JSON value.

  You should usually call Builder.transcription with a well-typed AudioTranscription value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• turnDetection

   final RealtimeTranscriptionSessionAudioInput.Builder turnDetection(RealtimeTranscriptionSessionAudioInputTurnDetection turnDetection)

  Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to null to turn off, in which case the client must manually trigger model response.

  Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.

  Semantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with "uhhm", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

• turnDetection

   final RealtimeTranscriptionSessionAudioInput.Builder turnDetection(Optional<RealtimeTranscriptionSessionAudioInputTurnDetection> turnDetection)

  Alias for calling Builder.turnDetection with turnDetection.orElse(null).

• turnDetection

   final RealtimeTranscriptionSessionAudioInput.Builder turnDetection(JsonField<RealtimeTranscriptionSessionAudioInputTurnDetection> turnDetection)

  Sets Builder.turnDetection to an arbitrary JSON value.

  You should usually call Builder.turnDetection with a well-typed RealtimeTranscriptionSessionAudioInputTurnDetection value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• turnDetection

   final RealtimeTranscriptionSessionAudioInput.Builder turnDetection(RealtimeTranscriptionSessionAudioInputTurnDetection.ServerVad serverVad)

  Alias for calling turnDetection with RealtimeTranscriptionSessionAudioInputTurnDetection.ofServerVad(serverVad).

• turnDetection

   final RealtimeTranscriptionSessionAudioInput.Builder turnDetection(RealtimeTranscriptionSessionAudioInputTurnDetection.SemanticVad semanticVad)

  Alias for calling turnDetection with RealtimeTranscriptionSessionAudioInputTurnDetection.ofSemanticVad(semanticVad).

• additionalProperties

   final RealtimeTranscriptionSessionAudioInput.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final RealtimeTranscriptionSessionAudioInput.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final RealtimeTranscriptionSessionAudioInput.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final RealtimeTranscriptionSessionAudioInput.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final RealtimeTranscriptionSessionAudioInput.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final RealtimeTranscriptionSessionAudioInput build()

  Returns an immutable instance of RealtimeTranscriptionSessionAudioInput.

  Further updates to this Builder will not mutate the returned instance.