Class TranscriptionSessionUpdatedEvent.Session
-
- All Implemented Interfaces:
public final class TranscriptionSessionUpdatedEvent.Session
A new Realtime transcription session configuration.
When a session is created on the server via REST API, the session object also contains an ephemeral key. Default TTL for keys is 10 minutes. This property is not present when a session is updated via the WebSocket API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
TranscriptionSessionUpdatedEvent.Session.Builder
A builder for Session.
public final class
TranscriptionSessionUpdatedEvent.Session.ClientSecret
Ephemeral key returned by the API. Only present when the session is created on the server via REST API.
public final class
TranscriptionSessionUpdatedEvent.Session.Modality
public final class
TranscriptionSessionUpdatedEvent.Session.TurnDetection
Configuration for turn detection. Can be set to
null
to turn off. 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.
-
Method Summary
-
-
Method Detail
-
clientSecret
final TranscriptionSessionUpdatedEvent.Session.ClientSecret clientSecret()
Ephemeral key returned by the API. Only present when the session is created on the server via REST API.
-
inputAudioFormat
final Optional<String> inputAudioFormat()
The format of input audio. Options are
pcm16
,g711_ulaw
, org711_alaw
.
-
inputAudioTranscription
final Optional<AudioTranscription> inputAudioTranscription()
Configuration of the transcription model.
-
modalities
final Optional<List<TranscriptionSessionUpdatedEvent.Session.Modality>> modalities()
The set of modalities the model can respond with. To disable audio, set this to "text".
-
turnDetection
final Optional<TranscriptionSessionUpdatedEvent.Session.TurnDetection> turnDetection()
Configuration for turn detection. Can be set to
null
to turn off. 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.
-
_clientSecret
final JsonField<TranscriptionSessionUpdatedEvent.Session.ClientSecret> _clientSecret()
Returns the raw JSON value of clientSecret.
Unlike clientSecret, this method doesn't throw if the JSON field has an unexpected type.
-
_inputAudioFormat
final JsonField<String> _inputAudioFormat()
Returns the raw JSON value of inputAudioFormat.
Unlike inputAudioFormat, this method doesn't throw if the JSON field has an unexpected type.
-
_inputAudioTranscription
final JsonField<AudioTranscription> _inputAudioTranscription()
Returns the raw JSON value of inputAudioTranscription.
Unlike inputAudioTranscription, this method doesn't throw if the JSON field has an unexpected type.
-
_modalities
final JsonField<List<TranscriptionSessionUpdatedEvent.Session.Modality>> _modalities()
Returns the raw JSON value of modalities.
Unlike modalities, this method doesn't throw if the JSON field has an unexpected type.
-
_turnDetection
final JsonField<TranscriptionSessionUpdatedEvent.Session.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 TranscriptionSessionUpdatedEvent.Session.Builder toBuilder()
-
validate
final TranscriptionSessionUpdatedEvent.Session validate()
-
builder
final static TranscriptionSessionUpdatedEvent.Session.Builder builder()
Returns a mutable builder for constructing an instance of Session.
The following fields are required:
.clientSecret()
-
-
-
-