Class: OpenAI::Models::Beta::BetaResponseFailedEvent

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

Defined Under Namespace

Classes: Agent

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, coerce_with_error, 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(response:, sequence_number:, agent: nil, type: :"response.failed") ⇒ Object

Parameters:

  • response —

    The response that failed.

  • sequence_number —

    The sequence number of this event.

  • agent (defaults to: nil) —

    The agent that owns this multi-agent streaming event.

  • type (defaults to: :"response.failed") —

    The type of the event. Always response.failed.




# File 'lib/openai/models/beta/beta_response_failed_event.rb', line 31

Instance Attribute Details

#agent ⇒ OpenAI::Beta::BetaResponseFailedEvent::Agent?

The agent that owns this multi-agent streaming event.

Returns:

  • (OpenAI::Beta::BetaResponseFailedEvent::Agent, nil) 


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

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

#response ⇒ OpenAI::Beta::BetaResponse

The response that failed.

Returns:

  • (OpenAI::Beta::BetaResponse) 


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

required :response, -> { OpenAI::Beta::BetaResponse }

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


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

required :sequence_number, Integer

#type ⇒ :"response.failed"

The type of the event. Always response.failed.

Returns:



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

required :type, const: :"response.failed"

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


42
 
# File 'sig/openai/models/beta/beta_response_failed_event.rbs', line 42

def to_hash: -> {