Class: OpenAI::Models::Live::ForkSessionConfig

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Live::ForkSessionConfig

Defined in:

lib/openai/models/live/fork_session_config.rb,
sig/openai/models/live/fork_session_config.rbs

Defined Under Namespace

Classes: Audio, Delegation

Instance Attribute Summary

• #audio ⇒ OpenAI::Models::Live::ForkSessionConfig::Audio^?

  Audio format for a WebSocket fork.

• #client ⇒ OpenAI::Models::Live::ClientConfig^?

  Frontend data-channel permissions for a WebRTC fork.

• #delegation ⇒ OpenAI::Models::Live::ForkSessionConfig::Delegation^?

  Overrides for the stored session’s Responses backend.

• #store ⇒ Boolean^?

  Whether to store the forked session.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(format_: nil) ⇒ Object constructor

  Audio format for a WebSocket fork.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(format_: nil) ⇒ Object

Audio format for a WebSocket fork. WebRTC forks negotiate their audio format and must omit this field.

Parameters:

• format_ (OpenAI::Models::Live::AudioFormat::AudioPCM, OpenAI::Models::Live::AudioFormat::AudioPCMU, OpenAI::Models::Live::AudioFormat::AudioPCMA) (defaults to: nil) —

  Audio encoding and sample rate for audio sent and received over a Live WebSocket connection. WebRTC and SIP negotiate their media format separately.

# File 'lib/openai/models/live/fork_session_config.rb', line 36

Instance Attribute Details

#audio ⇒ OpenAI::Models::Live::ForkSessionConfig::Audio^?

Audio format for a WebSocket fork. WebRTC forks negotiate their audio format and must omit this field.

Returns:

• (OpenAI::Models::Live::ForkSessionConfig::Audio, nil)

# File 'lib/openai/models/live/fork_session_config.rb', line 12

optional :audio, -> { OpenAI::Live::ForkSessionConfig::Audio }

#client ⇒ OpenAI::Models::Live::ClientConfig^?

Frontend data-channel permissions for a WebRTC fork. Omitted permissions inherit the stored values. Not supported for WebSocket forks.

Parameters:

• (OpenAI::Live::ClientConfig)

Returns:

• (OpenAI::Models::Live::ClientConfig, nil)

# File 'lib/openai/models/live/fork_session_config.rb', line 19

optional :client, -> { OpenAI::Live::ClientConfig }

#delegation ⇒ OpenAI::Models::Live::ForkSessionConfig::Delegation^?

Overrides for the stored session’s Responses backend. Only supported when the stored session already uses Responses delegation; the delegation type cannot change.

Returns:

• (OpenAI::Models::Live::ForkSessionConfig::Delegation, nil)

# File 'lib/openai/models/live/fork_session_config.rb', line 27

optional :delegation, -> { OpenAI::Live::ForkSessionConfig::Delegation }

#store ⇒ Boolean^?

Whether to store the forked session. Omission inherits the stored session's setting.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/openai/models/live/fork_session_config.rb', line 34

optional :store, OpenAI::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/live/fork_session_config.rbs', line 40

def to_hash: -> {