Class: OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/responses_server_event.rb,
sig/openai/models/responses/responses_server_event.rbs

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(error:, sequence_number: nil, status: nil, stream_id: nil, type: :error) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError for more details.

Emitted when an error occurs while processing a Responses WebSocket request.

Parameters:

  • error (OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error) —

    Details about the error.

  • sequence_number (Integer) (defaults to: nil) —

    The sequence number of an error emitted by the response stream.

  • status (Integer) (defaults to: nil) —

    The HTTP status code associated with a WebSocket protocol error.

  • stream_id (String) (defaults to: nil) —

    The WebSocket lane that emitted this event. This field is present when the

  • type (Symbol, :error) (defaults to: :error) —

    The type of the event. Always error.




# File 'lib/openai/models/responses/responses_server_event.rb', line 1183

Instance Attribute Details

#error ⇒ OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error

Details about the error.

Parameters:

  • value (OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error)

Returns:



1156
 
# File 'lib/openai/models/responses/responses_server_event.rb', line 1156

required :error, -> { OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error }

#sequence_number ⇒ Integer?

The sequence number of an error emitted by the response stream.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


1168
 
# File 'lib/openai/models/responses/responses_server_event.rb', line 1168

optional :sequence_number, Integer

#status ⇒ Integer?

The HTTP status code associated with a WebSocket protocol error.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


1174
 
# File 'lib/openai/models/responses/responses_server_event.rb', line 1174

optional :status, Integer

#stream_id ⇒ String?

The WebSocket lane that emitted this event. This field is present when the originating response.create event supplied a stream_id.

Parameters:

  • (String)

Returns:

  • (String, nil) 


1181
 
# File 'lib/openai/models/responses/responses_server_event.rb', line 1181

optional :stream_id, String

#type ⇒ Symbol, :error

The type of the event. Always error.

Parameters:

  • value (:error)

Returns:

  • (Symbol, :error) 


1162
 
# File 'lib/openai/models/responses/responses_server_event.rb', line 1162

required :type, const: :error

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1795
 
# File 'sig/openai/models/responses/responses_server_event.rbs', line 1795

def to_hash: -> {