Class: OpenAI::Models::Realtime::Connection

Inherits:
Object
  • Object
show all
Includes:
Enumerable[OpenAI::Models::Realtime::connection_server_event]
Defined in:
sig/openai/helpers/realtime/connection.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Connection

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.

Returns a new instance of Connection.

Parameters:

  • socket: (Object)
  • url: (URI::Generic) 


22
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 22

def initialize: (socket: untyped, url: URI::Generic) -> void

Instance Attribute Details

#conversation ⇒ OpenAI::Realtime::ConnectionResources::Conversation (readonly)

Returns the value of attribute conversation.

Returns:



18
19
20
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 18

def conversation
  @conversation
end

#input_audio_buffer ⇒ OpenAI::Realtime::ConnectionResources::InputAudioBuffer (readonly)

Returns the value of attribute input_audio_buffer.

Returns:



19
20
21
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 19

def input_audio_buffer
  @input_audio_buffer
end

#response ⇒ OpenAI::Realtime::ConnectionResources::Response (readonly)

Returns the value of attribute response.

Returns:



17
18
19
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 17

def response
  @response
end

#session ⇒ OpenAI::Realtime::ConnectionResources::Session (readonly)

Returns the value of attribute session.

Returns:



16
17
18
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 16

def session
  @session
end

#url ⇒ URI::Generic (readonly)

Returns the value of attribute url.

Returns:

  • (URI::Generic) 


15
16
17
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 15

def url
  @url
end

Instance Method Details

#abort ⇒ nil

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.

Returns:

  • (nil) 


40
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 40

def abort: -> nil

#close ⇒ nil

Parameters:

  • code: (Integer)
  • reason: (String)

Returns:

  • (nil) 


37
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 37

def close: (?code: Integer, ?reason: String) -> nil

#closed? ⇒ Boolean

Returns:



41
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 41

def closed?: -> bool

#each ⇒ void

This method returns an undefined value.



23
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 23

def each:

#parse_event ⇒ Object 



30
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 30

def parse_event: (

#receive ⇒ OpenAI::Models::Realtime::connection_server_event?

Returns:

  • (OpenAI::Models::Realtime::connection_server_event, nil) 


28
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 28

def receive: -> OpenAI::Models::Realtime::connection_server_event?

#receive_raw ⇒ String?

Returns:

  • (String, nil) 


29
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 29

def receive_raw: -> String?

#send_event ⇒ Object 



33
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 33

def send_event: (

#send_raw ⇒ nil

Parameters:

  • data (String)

Returns:

  • (nil) 


36
 
# File 'sig/openai/helpers/realtime/connection.rbs', line 36

def send_raw: (String data) -> nil