Class: OpenAI::Models::Beta::BetaResponseErrorEvent

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

Defined Under Namespace

Classes: Agent

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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:, sequence_number:, agent: nil, type: :error) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseErrorEvent for more details.

Emitted when an error occurs.

Parameters:

  • code (String, nil) —

    The error code.

  • message (String) —

    The error message.

  • param (String, nil) —

    The error parameter.

  • sequence_number (Integer) —

    The sequence number of this event.

  • agent (OpenAI::Models::Beta::BetaResponseErrorEvent::Agent, nil) (defaults to: nil) —

    The agent that owns this multi-agent streaming event.

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

    The type of the event. Always error.




# File 'lib/openai/models/beta/beta_response_error_event.rb', line 43

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseErrorEvent::Agent?

The agent that owns this multi-agent streaming event.

Parameters:

  • value (OpenAI::Beta::BetaResponseErrorEvent::Agent, nil)

Returns:



41
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 41

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

#code ⇒ String?

The error code.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


11
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 11

required :code, String, nil?: true

#message ⇒ String

The error message.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 17

required :message, String

#param ⇒ String?

The error parameter.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 23

required :param, String, nil?: true

#sequence_number ⇒ Integer

The sequence number of this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


29
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 29

required :sequence_number, Integer

#type ⇒ Symbol, :error

The type of the event. Always error.

Parameters:

  • value (:error)

Returns:

  • (Symbol, :error) 


35
 
# File 'lib/openai/models/beta/beta_response_error_event.rb', line 35

required :type, const: :error

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


38
 
# File 'sig/openai/models/beta/beta_response_error_event.rbs', line 38

def to_hash: -> {