Class RealtimeSessionCreateResponse.Audio.Input
-
- All Implemented Interfaces:
public final class RealtimeSessionCreateResponse.Audio.Input
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeSessionCreateResponse.Audio.Input.BuilderA builder for Input.
public final classRealtimeSessionCreateResponse.Audio.Input.NoiseReductionConfiguration for input audio noise reduction. This can be set to
nullto 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.public final classRealtimeSessionCreateResponse.Audio.Input.TurnDetectionConfiguration for turn detection, ether Server VAD or Semantic VAD. This can be set to
nullto 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.
For
gpt-realtime-whispertranscription sessions, turn detection must be set tonull; VAD is not supported.
-
Method Summary
-
-
Method Detail
-
format
final Optional<RealtimeAudioFormats> format()
The format of the input audio.
-
noiseReduction
final Optional<RealtimeSessionCreateResponse.Audio.Input.NoiseReduction> noiseReduction()
Configuration for input audio noise reduction. This can be set to
nullto 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()
-
turnDetection
final Optional<RealtimeSessionCreateResponse.Audio.Input.TurnDetection> turnDetection()
Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to
nullto 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.
For
gpt-realtime-whispertranscription sessions, turn detection must be set tonull; VAD is not supported.
-
_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<RealtimeSessionCreateResponse.Audio.Input.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<RealtimeSessionCreateResponse.Audio.Input.TurnDetection> _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 RealtimeSessionCreateResponse.Audio.Input.Builder toBuilder()
-
validate
final RealtimeSessionCreateResponse.Audio.Input validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static RealtimeSessionCreateResponse.Audio.Input.Builder builder()
Returns a mutable builder for constructing an instance of Input.
-
-
-
-