Module: OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include

Extended by:

Internal::Type::Enum

Defined in:

lib/openai/models/realtime/realtime_session_create_request.rb

Constant Summary

ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS =

:"item.input_audio_transcription.logprobs"

Instance Method Summary

• #initialize(audio: nil, include: nil, instructions: nil, max_output_tokens: nil, model: nil, output_modalities: nil, prompt: nil, tool_choice: nil, tools: nil, tracing: nil, truncation: nil, type: :realtime) ⇒ Object

  Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeSessionCreateRequest 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(audio: nil, include: nil, instructions: nil, max_output_tokens: nil, model: nil, output_modalities: nil, prompt: nil, tool_choice: nil, tools: nil, tracing: nil, truncation: nil, type: :realtime) ⇒ Object

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

Realtime session object configuration.

Parameters:

• audio (OpenAI::Models::Realtime::RealtimeAudioConfig) (defaults to: nil) —

  Configuration for input and output audio.

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

  Additional fields to include in server outputs.

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

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

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

  Maximum number of output tokens for a single assistant response,

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

  The Realtime model used for this session.

• output_modalities (Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>) (defaults to: nil) —

  The set of modalities the model can respond with. It defaults to ‘[“audio”]`, in

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

  Reference to a prompt template and its variables.

• tool_choice (Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp) (defaults to: nil) —

  How the model chooses tools. Provide one of the string modes or force a specific

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

  Tools available to the model.

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

  Realtime API can write session traces to the [Traces Dashboard](/logs?api=traces

• truncation (Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio) (defaults to: nil) —

  When the number of tokens in a conversation exceeds the model’s input token limi

• type (Symbol, :realtime) (defaults to: :realtime) —

  The type of session to create. Always ‘realtime` for the Realtime API.

# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 153

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

  ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS = :"item.input_audio_transcription.logprobs"

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