Class: OpenAI::Models::Live::ServerEventSelector

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/live/server_event_selector.rb,
sig/openai/models/live/server_event_selector.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

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(type:, response_event: nil) ⇒ ServerEventSelector

A Live server event selector for the WebRTC frontend data channel.

Parameters:

  • type (String) —

    The outer Live server event type. Use 'response.event' for Responses events.

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

    The nested Responses event type. Required when type is 'response.event'; forbidden for other event types.

  • type: (String)
  • response_event: (String) (defaults to: nil) 



# File 'lib/openai/models/live/server_event_selector.rb', line 20

Instance Attribute Details

#response_event ⇒ String?

The nested Responses event type. Required when type is 'response.event'; forbidden for other event types.

Parameters:

  • (String)

Returns:

  • (String, nil) 


18
 
# File 'lib/openai/models/live/server_event_selector.rb', line 18

optional :response_event, String

#type ⇒ String

The outer Live server event type. Use 'response.event' for Responses events.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/live/server_event_selector.rb', line 11

required :type, String

Instance Method Details

#to_hash ⇒ { type: String, ?response_event: String }

Returns:

  • ({ type: String, ?response_event: String }) 


15
 
# File 'sig/openai/models/live/server_event_selector.rbs', line 15

def to_hash: -> { type: String, ?response_event: String }