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 ⇒ 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. 



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

def initialize: (

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) 


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

def abort: -> nil

#close ⇒ nil

Parameters:

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

Returns:

  • (nil) 


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

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

#closed? ⇒ Boolean

Returns:



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

def closed?: -> bool

#each ⇒ void

This method returns an undefined value.



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

def each:

#flush_pending ⇒ nil

Returns:

  • (nil) 


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

def flush_pending: -> nil

#parse_event ⇒ Object 



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

def parse_event: (

#pending_messages ⇒ Array[String]

Returns:

  • (Array[String]) 


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

def pending_messages: -> Array[String]

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

Returns:

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


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

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

#receive_raw ⇒ String?

Returns:

  • (String, nil) 


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

def receive_raw: -> String?

#reconnecting? ⇒ Boolean

Returns:



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

def reconnecting?: -> bool

#send_event ⇒ Object 



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

def send_event: (

#send_raw ⇒ nil

Parameters:

  • data (String)

Returns:

  • (nil) 


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

def send_raw: (String data) -> nil

#take_pending_messages ⇒ Array[String]

Returns:

  • (Array[String]) 


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

def take_pending_messages: -> Array[String]