Class: OpenAI::Models::Responses::ResponseSteerFailedEvent

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

Defined Under Namespace

Classes: Error, Steer

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(code:, message:, type: :invalid_request_error) ⇒ Object

Information about why the input could not be committed.

Parameters:

  • code (Symbol, String, OpenAI::Models::Responses::ResponseSteerErrorCode) —

    A machine-readable steering error code. Clients should handle unknown values because additional codes may be introduced. Known values include:

    • response_not_found: The target response is not available on this connection.
    • invalid_input: The event or input failed validation.
    • steering_not_supported: The model or response execution mode does not support steering.
    • too_many_pending_steers: Too much steering input is pending for the response.
    • response_already_completed: The response completed and is no longer accepting steering input.
    • response_not_active: The response is no longer accepting steering input.
    • successor_creation_failed: The successor response could not be created.
  • message (String) —

    A human-readable description of the error.

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

    The error type. Always invalid_request_error.




# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 38

Instance Attribute Details

#error ⇒ OpenAI::Models::Responses::ResponseSteerFailedEvent::Error

Information about why the input could not be committed.

Parameters:

  • value (OpenAI::Responses::ResponseSteerFailedEvent::Error)

Returns:



11
 
# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 11

required :error, -> { OpenAI::Responses::ResponseSteerFailedEvent::Error }

#sequence_number ⇒ Integer

The sequence number for this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 17

required :sequence_number, Integer

#steer ⇒ OpenAI::Models::Responses::ResponseSteerFailedEvent::Steer

The steering submission that could not be committed.

Parameters:

  • value (OpenAI::Responses::ResponseSteerFailedEvent::Steer)

Returns:



23
 
# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 23

required :steer, -> { OpenAI::Responses::ResponseSteerFailedEvent::Steer }

#stream_id ⇒ String?

The WebSocket lane that emitted this event, when the target response is available and its response.create event supplied a stream_id.

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 36

optional :stream_id, String

#type ⇒ Symbol, :"response.steer.failed"

The event discriminator. Always response.steer.failed.

Parameters:

  • value (:"response.steer.failed")

Returns:

  • (Symbol, :"response.steer.failed") 


29
 
# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 29

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/responses/response_steer_failed_event.rbs', line 34

def to_hash: -> {