Class RealtimeAudioConfigInput
-
- All Implemented Interfaces:
public final class RealtimeAudioConfigInput
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RealtimeAudioConfigInput.Builder
A builder for RealtimeAudioConfigInput.
public final class
RealtimeAudioConfigInput.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.
-
Method Summary
-
-
Method Detail
-
format
final Optional<RealtimeAudioFormats> format()
The format of the input audio.
-
noiseReduction
final Optional<RealtimeAudioConfigInput.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.
-
transcription
final Optional<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.
-
turnDetection
final Optional<RealtimeAudioInputTurnDetection> 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.
-
_format
final JsonField<RealtimeAudioFormats> _format()
Returns the raw JSON value of format.
Unlike format, this method doesn't throw if the JSON field has an unexpected type.
-
_noiseReduction
final JsonField<RealtimeAudioConfigInput.NoiseReduction> _noiseReduction()
Returns the raw JSON value of noiseReduction.
Unlike noiseReduction, this method doesn't throw if the JSON field has an unexpected type.
-
_transcription
final JsonField<AudioTranscription> _transcription()
Returns the raw JSON value of transcription.
Unlike transcription, this method doesn't throw if the JSON field has an unexpected type.
-
_turnDetection
final JsonField<RealtimeAudioInputTurnDetection> _turnDetection()
Returns the raw JSON value of turnDetection.
Unlike turnDetection, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RealtimeAudioConfigInput.Builder toBuilder()
-
validate
final RealtimeAudioConfigInput validate()
-
builder
final static RealtimeAudioConfigInput.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeAudioConfigInput.
-
-
-
-