Class: OpenAI::Models::Beta::AssistantStreamEvent::ErrorEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::AssistantStreamEvent::ErrorEvent

Defined in:

lib/openai/models/beta/assistant_stream_event.rb,
sig/openai/models/beta/assistant_stream_event.rbs

Instance Attribute Summary

• #data ⇒ OpenAI::Models::ErrorObject
• #event ⇒ Symbol, :error

Instance Method Summary

• #initialize(data:, event: :error) ⇒ ErrorEvent constructor

  Occurs when an error occurs.

• #to_hash ⇒ { data: OpenAI::ErrorObject, event: :error }

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(data:, event: :error) ⇒ ErrorEvent

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

Parameters:

• data (OpenAI::Models::ErrorObject)
• event (Symbol, :error) (defaults to: :error)
• data: (OpenAI::ErrorObject)
• event: (:error) (defaults to: :error)

# File 'lib/openai/models/beta/assistant_stream_event.rb', line 722

Instance Attribute Details

#data ⇒ OpenAI::Models::ErrorObject

Parameters:

• value (OpenAI::ErrorObject)

Returns:

• (OpenAI::Models::ErrorObject)

# File 'lib/openai/models/beta/assistant_stream_event.rb', line 715

required :data, -> { OpenAI::ErrorObject }

#event ⇒ Symbol, :error

Parameters:

• value (:error)

Returns:

• (Symbol, :error)

# File 'lib/openai/models/beta/assistant_stream_event.rb', line 720

required :event, const: :error

Instance Method Details

#to_hash ⇒ { data: OpenAI::ErrorObject, event: :error }

Returns:

• ({ data: OpenAI::ErrorObject, event: :error })

# File 'sig/openai/models/beta/assistant_stream_event.rbs', line 528

def to_hash: -> { data: OpenAI::ErrorObject, event: :error }