Module: OpenAI::Helpers::ResponsesWebSocket::Connections

Included in:
Resources::Responses
Defined in:
lib/openai/helpers/responses_websocket/resources/responses_extension.rb

Overview

Ruby-native WebSocket entry point layered onto the generated Responses resource.

Instance Method Summary collapse

Instance Method Details

#connect(websocket_base_url: nil, request_options: nil, transport: nil, transport_options: {}, &block) ⇒ Object

Raises:

  • (ArgumentError) 


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/openai/helpers/responses_websocket/resources/responses_extension.rb', line 8

def connect(
  websocket_base_url: nil,
  request_options: nil,
  transport: nil,
  transport_options: {},
  &block
)
  raise ArgumentError, "A block is required to open a Responses WebSocket." unless block

  manager = OpenAI::Responses::ConnectionManager.new(
    client: @client,
    websocket_base_url: websocket_base_url,
    transport: transport,
    request_options: request_options,
    transport_options: transport_options
  )
  manager.open(&block)
end