Constructor Detail

Method Detail

• id

   final Optional<String> id()

  Unique identifier for the session that looks like sess_1234567890abcdef.

• expiresAt

   final Optional<Long> expiresAt()

  Expiration timestamp for the session, in seconds since epoch.

• include

   final Optional<List<RealtimeSession.Include>> include()

  Additional fields to include in server outputs.

  • item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.

• inputAudioFormat

   final Optional<RealtimeSession.InputAudioFormat> inputAudioFormat()

  The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, input audio must be 16-bit PCM at a 24kHz sample rate, single channel (mono), and little-endian byte order.

• inputAudioNoiseReduction

   final Optional<RealtimeSession.InputAudioNoiseReduction> inputAudioNoiseReduction()

  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.

• inputAudioTranscription

   final Optional<AudioTranscription> inputAudioTranscription()

  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.

• instructions

   final Optional<String> instructions()

  The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. "be extremely succinct", "act friendly", "here are examples of good responses") and on audio behavior (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.

  Note that the server sets default instructions which will be used if this field is not set and are visible in the session.created event at the start of the session.

• maxResponseOutputTokens

   final Optional<RealtimeSession.MaxResponseOutputTokens> maxResponseOutputTokens()

  Maximum number of output tokens for a single assistant response, inclusive of tool calls. Provide an integer between 1 and 4096 to limit output tokens, or inf for the maximum available tokens for a given model. Defaults to inf.

• modalities

   final Optional<List<RealtimeSession.Modality>> modalities()

  The set of modalities the model can respond with. To disable audio, set this to "text".

• model

   final Optional<RealtimeSession.Model> model()

  The Realtime model used for this session.

• object_

   final Optional<RealtimeSession.Object> object_()

  The object type. Always realtime.session.

• outputAudioFormat

   final Optional<RealtimeSession.OutputAudioFormat> outputAudioFormat()

  The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, output audio is sampled at a rate of 24kHz.

• prompt

   final Optional<ResponsePrompt> prompt()

  Reference to a prompt template and its variables. Learn more.

• speed

   final Optional<Double> speed()

  The speed of the model's spoken response. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.

• temperature

   final Optional<Double> temperature()

  Sampling temperature for the model, limited to 0.6, 1.2. For audio models a temperature of 0.8 is highly recommended for best performance.

• toolChoice

   final Optional<String> toolChoice()

  How the model chooses tools. Options are auto, none, required, or specify a function.

• tools

   final Optional<List<RealtimeFunctionTool>> tools()

  Tools (functions) available to the model.

• tracing

   final Optional<RealtimeSession.Tracing> tracing()

  Configuration options for tracing. Set to null to disable tracing. Once tracing is enabled for a session, the configuration cannot be modified.

  auto will create a trace for the session with default values for the workflow name, group id, and metadata.

• turnDetection

   final Optional<RealtimeSession.TurnDetection> 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.

• voice

   final Optional<RealtimeSession.Voice> voice()

  The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are alloy, ash, ballad, coral, echo, sage, shimmer, and verse.

• _id

   final JsonField<String> _id()

  Returns the raw JSON value of id.

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

• _expiresAt

   final JsonField<Long> _expiresAt()

  Returns the raw JSON value of expiresAt.

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

• _include

   final JsonField<List<RealtimeSession.Include>> _include()

  Returns the raw JSON value of include.

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

• _inputAudioFormat

   final JsonField<RealtimeSession.InputAudioFormat> _inputAudioFormat()

  Returns the raw JSON value of inputAudioFormat.

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

• _inputAudioNoiseReduction

   final JsonField<RealtimeSession.InputAudioNoiseReduction> _inputAudioNoiseReduction()

  Returns the raw JSON value of inputAudioNoiseReduction.

  Unlike inputAudioNoiseReduction, 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.

• _instructions

   final JsonField<String> _instructions()

  Returns the raw JSON value of instructions.

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

• _maxResponseOutputTokens

   final JsonField<RealtimeSession.MaxResponseOutputTokens> _maxResponseOutputTokens()

  Returns the raw JSON value of maxResponseOutputTokens.

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

• _modalities

   final JsonField<List<RealtimeSession.Modality>> _modalities()

  Returns the raw JSON value of modalities.

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

• _model

   final JsonField<RealtimeSession.Model> _model()

  Returns the raw JSON value of model.

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

• _object_

   final JsonField<RealtimeSession.Object> _object_()

  Returns the raw JSON value of object_.

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

• _outputAudioFormat

   final JsonField<RealtimeSession.OutputAudioFormat> _outputAudioFormat()

  Returns the raw JSON value of outputAudioFormat.

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

• _prompt

   final JsonField<ResponsePrompt> _prompt()

  Returns the raw JSON value of prompt.

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

• _speed

   final JsonField<Double> _speed()

  Returns the raw JSON value of speed.

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

• _temperature

   final JsonField<Double> _temperature()

  Returns the raw JSON value of temperature.

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

• _toolChoice

   final JsonField<String> _toolChoice()

  Returns the raw JSON value of toolChoice.

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

• _tools

   final JsonField<List<RealtimeFunctionTool>> _tools()

  Returns the raw JSON value of tools.

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

• _tracing

   final JsonField<RealtimeSession.Tracing> _tracing()

  Returns the raw JSON value of tracing.

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

• _turnDetection

   final JsonField<RealtimeSession.TurnDetection> _turnDetection()

  Returns the raw JSON value of turnDetection.

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

• _voice

   final JsonField<RealtimeSession.Voice> _voice()

  Returns the raw JSON value of voice.

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

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final RealtimeSession.Builder toBuilder()

• validate

   final RealtimeSession validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static RealtimeSession.Builder builder()

  Returns a mutable builder for constructing an instance of RealtimeSession.