Class: OpenAI::Responses::UnknownServerEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/helpers/responses_websocket/unknown_server_event.rb

Overview

A valid JSON event whose discriminator is newer than this SDK version.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data:) ⇒ UnknownServerEvent

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



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 17

def initialize(data:)
  value = data.fetch(:type)
  unless value.is_a?(String) || value.is_a?(Symbol)
    raise ArgumentError, "Responses server event type must be a string or symbol"
  end

  @type = value.to_sym
  @stream_id = data[:stream_id]
  @data = freeze_json(data)
  freeze
end

Instance Attribute Details

#data ⇒ Hash{Symbol=>Object} (readonly)

Returns:

  • (Hash{Symbol=>Object}) 


11
12
13
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 11

def data
  @data
end

#stream_id ⇒ Object (readonly)

Returns:

  • (Object) 


14
15
16
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 14

def stream_id
  @stream_id
end

#type ⇒ Symbol (readonly)

Returns:

  • (Symbol) 


8
9
10
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 8

def type
  @type
end

Instance Method Details

#inspect ⇒ Object Also known as: to_s

Keep routine diagnostics payload-free. Callers that explicitly need the unknown JSON can use #data or #to_h.



34
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 34

def inspect = "#<#{self.class} type=#{@type.inspect}>"

#to_h ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


30
 
# File 'lib/openai/helpers/responses_websocket/unknown_server_event.rb', line 30

def to_h = @data