Module: OpenAI::Models::Realtime::RealtimeSession::Include

Extended by:

Internal::Type::Enum

Defined in:

lib/openai/models/realtime/realtime_session.rb

Constant Summary

ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS =

:"item.input_audio_transcription.logprobs"

Instance Method Summary

• #initialize(id: nil, expires_at: nil, include: nil, input_audio_format: nil, input_audio_noise_reduction: nil, input_audio_transcription: nil, instructions: nil, max_response_output_tokens: nil, modalities: nil, model: nil, object: nil, output_audio_format: nil, prompt: nil, speed: nil, temperature: nil, tool_choice: nil, tools: nil, tracing: nil, turn_detection: nil, voice: nil) ⇒ Object

  Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeSession for more details.

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(id: nil, expires_at: nil, include: nil, input_audio_format: nil, input_audio_noise_reduction: nil, input_audio_transcription: nil, instructions: nil, max_response_output_tokens: nil, modalities: nil, model: nil, object: nil, output_audio_format: nil, prompt: nil, speed: nil, temperature: nil, tool_choice: nil, tools: nil, tracing: nil, turn_detection: nil, voice: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeSession for more details.

Realtime session object for the beta interface.

Parameters:

• id (String) (defaults to: nil) —

  Unique identifier for the session that looks like ‘sess_1234567890abcdef`.

• expires_at (Integer) (defaults to: nil) —

  Expiration timestamp for the session, in seconds since epoch.

• include (Array<Symbol, OpenAI::Models::Realtime::RealtimeSession::Include>, nil) (defaults to: nil) —

  Additional fields to include in server outputs.

• input_audio_format (Symbol, OpenAI::Models::Realtime::RealtimeSession::InputAudioFormat) (defaults to: nil) —

  The format of input audio. Options are ‘pcm16`, `g711_ulaw`, or `g711_alaw`.

• input_audio_noise_reduction (OpenAI::Models::Realtime::RealtimeSession::InputAudioNoiseReduction) (defaults to: nil) —

  Configuration for input audio noise reduction. This can be set to ‘null` to turn

• input_audio_transcription (OpenAI::Models::Realtime::AudioTranscription, nil) (defaults to: nil) —

  Configuration for input audio transcription, defaults to off and can be set to ‘

• instructions (String) (defaults to: nil) —

  The default system instructions (i.e. system message) prepended to model

• max_response_output_tokens (Integer, Symbol, :inf) (defaults to: nil) —

  Maximum number of output tokens for a single assistant response,

• modalities (Array<Symbol, OpenAI::Models::Realtime::RealtimeSession::Modality>) (defaults to: nil) —

  The set of modalities the model can respond with. To disable audio,

• model (Symbol, OpenAI::Models::Realtime::RealtimeSession::Model) (defaults to: nil) —

  The Realtime model used for this session.

• object (Symbol, OpenAI::Models::Realtime::RealtimeSession::Object) (defaults to: nil) —

  The object type. Always ‘realtime.session`.

• output_audio_format (Symbol, OpenAI::Models::Realtime::RealtimeSession::OutputAudioFormat) (defaults to: nil) —

  The format of output audio. Options are ‘pcm16`, `g711_ulaw`, or `g711_alaw`.

• prompt (OpenAI::Models::Responses::ResponsePrompt, nil) (defaults to: nil) —

  Reference to a prompt template and its variables.

• speed (Float) (defaults to: nil) —

  The speed of the model’s spoken response. 1.0 is the default speed. 0.25 is

• temperature (Float) (defaults to: nil) —

  Sampling temperature for the model, limited to [0.6, 1.2]. For audio models a te

• tool_choice (String) (defaults to: nil) —

  How the model chooses tools. Options are ‘auto`, `none`, `required`, or

• tools (Array<OpenAI::Models::Realtime::RealtimeFunctionTool>) (defaults to: nil) —

  Tools (functions) available to the model.

• tracing (Symbol, :auto, OpenAI::Models::Realtime::RealtimeSession::Tracing::TracingConfiguration, nil) (defaults to: nil) —

  Configuration options for tracing. Set to null to disable tracing. Once

• turn_detection (OpenAI::Models::Realtime::RealtimeSession::TurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeSession::TurnDetection::SemanticVad, nil) (defaults to: nil) —

  Configuration for turn detection, ether Server VAD or Semantic VAD. This can be

• voice (String, Symbol, OpenAI::Models::Realtime::RealtimeSession::Voice) (defaults to: nil) —

  The voice the model uses to respond. Voice cannot be changed during the

# File 'lib/openai/models/realtime/realtime_session.rb', line 230

module Include
  extend OpenAI::Internal::Type::Enum

  ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS = :"item.input_audio_transcription.logprobs"

  # @!method self.values
  #   @return [Array<Symbol>]
end