Class: OpenAI::Models::Beta::BetaResponseSteerPendingEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_steer_pending_event.rb,
sig/openai/models/beta/beta_response_steer_pending_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(reason:, required_input:, sequence_number:, steer:, stream_id: nil, type: :"response.steer.pending") ⇒ Object

Parameters:

  • reason —

    An extensible enum describing why accepted steering input is still queued. Clients should handle unknown values because additional reasons may be introduced. Known values include:

    • waiting_for_required_input: The response is waiting for the tool results or approval decisions identified by required_input.
  • required_input —

    Input stubs identifying outstanding client-owned tool results or approval decisions. Each stub contains identifying fields only; the client supplies the result before including it in response.create.

  • sequence_number —

    The sequence number for this event.

  • steer —

    The steering submission that remains queued.

  • stream_id (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 (defaults to: :"response.steer.pending") —

    The event discriminator. Always response.steer.pending.




# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 54

Instance Attribute Details

#reason ⇒ OpenAI::Models::Beta::beta_response_steer_pending_reason

An extensible enum describing why accepted steering input is still queued. Clients should handle unknown values because additional reasons may be introduced. Known values include:

  • waiting_for_required_input: The response is waiting for the tool results or approval decisions identified by required_input.

Returns:

  • (OpenAI::Models::Beta::beta_response_steer_pending_reason) 


16
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 16

required :reason, union: -> { OpenAI::Beta::BetaResponseSteerPendingReason }

#required_input ⇒ ::Array[OpenAI::Models::Beta::beta_response_steer_required_input]

Input stubs identifying outstanding client-owned tool results or approval decisions. Each stub contains identifying fields only; the client supplies the result before including it in response.create.

Returns:

  • (::Array[OpenAI::Models::Beta::beta_response_steer_required_input]) 


24
25
26
27
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 24

required(
  :required_input,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseSteerRequiredInput] }
)

#sequence_number ⇒ Integer

The sequence number for this event.

Returns:

  • (Integer) 


33
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 33

required :sequence_number, Integer

#steer ⇒ OpenAI::Beta::BetaResponseSteerPendingEvent::Steer

The steering submission that remains queued.

Returns:

  • (OpenAI::Beta::BetaResponseSteerPendingEvent::Steer) 


39
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 39

required :steer, -> { OpenAI::Beta::BetaResponseSteerPendingEvent::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.

Returns:

  • (String, nil) 


52
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 52

optional :stream_id, String

#type ⇒ :"response.steer.pending"

The event discriminator. Always response.steer.pending.

Returns:

  • (:"response.steer.pending") 


45
 
# File 'lib/openai/models/beta/beta_response_steer_pending_event.rb', line 45

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


76
 
# File 'sig/openai/models/beta/beta_response_steer_pending_event.rbs', line 76

def to_hash: -> {