Class: OpenAI::Models::Responses::Session

Inherits:
Object
  • Object
show all
Defined in:
sig/openai/helpers/responses_websocket/session.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



88
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 88

def initialize: (

Instance Attribute Details

#default ⇒ SessionLane (readonly)

Returns the value of attribute default.

Returns:



68
69
70
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 68

def default
  @default
end

#limits ⇒ SessionLimits (readonly)

Returns the value of attribute limits.

Returns:



67
68
69
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 67

def limits
  @limits
end

Class Method Details

.open ⇒ void

This method returns an undefined value.



69
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 69

def self.open: [Result] (

Instance Method Details

#assert_owner! ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.



113
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 113

def assert_owner!: -> void

#check_reader! ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.



110
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 110

def check_reader!: -> void

#close ⇒ void

This method returns an undefined value.



85
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 85

def close: -> void

#consumed ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • bytes (Integer) 


116
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 116

def consumed: (Integer bytes) -> void

#detach ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:



119
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 119

def detach: (SessionLane value) -> void

#encode_client_event ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



102
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 102

def encode_client_event: (

#lane ⇒ SessionLane

Parameters:

  • stream_id (String, nil)

Returns:



79
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 79

def lane: (String? stream_id) -> SessionLane

#reconnect ⇒ Object 



80
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 80

def reconnect: (

#send_event ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • event (connection_client_event) 


107
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 107

def send_event: (connection_client_event event) -> void

#start ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.



99
 
# File 'sig/openai/helpers/responses_websocket/session.rbs', line 99

def start: -> void