Class: OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_responses_server_event.rb

Defined Under Namespace

Classes: Agent, 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(code:, message:, param:, type:, headers: nil) ⇒ Object

Details about the error.

Parameters:

  • code (String, nil) —

    The error code that was emitted, if any.

  • message (String) —

    The human-readable error message that was emitted.

  • param (String, nil) —

    The parameter name that was associated with the error, if any.

  • type (String) —

    The error type that was emitted.

  • headers (Hash{Symbol=>String}) (defaults to: nil) —

    The response headers that were emitted with the error, if any.




# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1205

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Agent?

The agent that owns this multi-agent streaming event.

Returns:



1180
1181
1182
1183
1184
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1180

optional :agent,
-> {
  OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Agent
},
nil?: true

#error ⇒ OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error

Details about the error.

Returns:



1168
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1168

required :error, -> { OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error }

#sequence_number ⇒ Integer?

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

Returns:

  • (Integer, nil) 


1190
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1190

optional :sequence_number, Integer

#status ⇒ Integer?

The HTTP status code associated with a WebSocket protocol error.

Returns:

  • (Integer, nil) 


1196
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1196

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.

Returns:

  • (String, nil) 


1203
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1203

optional :stream_id, String

#type ⇒ Symbol, :error

The type of the event. Always error.

Returns:

  • (Symbol, :error) 


1174
 
# File 'lib/openai/models/beta/beta_responses_server_event.rb', line 1174

required :type, const: :error