Class: OpenAI::Models::Responses::ResponseQueuedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_queued_event.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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, 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: , type: :"response.queued") ⇒ Object

Emitted when a response is queued and waiting to be processed.

Parameters:

  • response (OpenAI::Models::Responses::Response) (defaults to: ) —

    The full response object that is queued.

  • sequence_number (Integer) (defaults to: ) —

    The sequence number for this event.

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

    The type of the event. Always ‘response.queued’.




# File 'lib/openai/models/responses/response_queued_event.rb', line 25

Instance Attribute Details

#response ⇒ OpenAI::Models::Responses::Response

The full response object that is queued.

Returns:



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

required :response, -> { OpenAI::Responses::Response }

#sequence_number ⇒ Integer

The sequence number for this event.

Returns:

  • (Integer) 


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

required :sequence_number, Integer

#type ⇒ Symbol, :"response.queued"

The type of the event. Always ‘response.queued’.

Returns:



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

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