Class: OpenAI::Models::Responses::ResponseSteerAcceptedEvent

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

Defined Under Namespace

Classes: 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(sequence_number:, steer:, stream_id: nil, type: :"response.steer.accepted") ⇒ Object

Emitted when steering input has been validated and queued. Acceptance means the server owns the input, not that it has been applied. The successor's response.created event is the commit point. If accepted input cannot be committed, response.steer.failed returns it with the same steering ID.

When the response stops for client-owned tool output or approval, the input remains queued and response.steer.pending is emitted after response.completed. Fill the pending event's required_input stubs with saved results and send one matching explicit response.create per parent. Do not resend accepted input while it is still queued.

Parameters:

  • sequence_number (Integer) —

    The sequence number for this event.

  • steer (OpenAI::Models::Responses::ResponseSteerAcceptedEvent::Steer) —

    The accepted steering submission.

  • stream_id (String) (defaults to: nil) —

    The WebSocket lane that emitted this event. This field is present when the target response's response.create event supplied a stream_id.

  • type (Symbol, :"response.steer.accepted") (defaults to: :"response.steer.accepted") —

    The event discriminator. Always response.steer.accepted.




# File 'lib/openai/models/responses/response_steer_accepted_event.rb', line 32

Instance Attribute Details

#sequence_number ⇒ Integer

The sequence number for this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :sequence_number, Integer

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

The accepted steering submission.

Parameters:

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

Returns:



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

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

#stream_id ⇒ String?

The WebSocket lane that emitted this event. This field is present when the target response's response.create event supplied a stream_id.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/openai/models/responses/response_steer_accepted_event.rb', line 30

optional :stream_id, String

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

The event discriminator. Always response.steer.accepted.

Parameters:

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

Returns:

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


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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


30
 
# File 'sig/openai/models/responses/response_steer_accepted_event.rbs', line 30

def to_hash: -> {