Class: OpenAI::Models::Realtime::ResponseCreatedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/response_created_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, 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(event_id:, response:, type: :"response.created") ⇒ Object

Returned when a new Response is created. The first event of response creation, where the response is in an initial state of in_progress.

Parameters:

  • The unique ID of the server event.

  • The response resource.

  • (defaults to: :"response.created")

    The event type, must be response.created.



# File 'lib/openai/models/realtime/response_created_event.rb', line 25


Instance Attribute Details

#event_idString

The unique ID of the server event.

Returns:



11
# File 'lib/openai/models/realtime/response_created_event.rb', line 11

required :event_id, String

#responseOpenAI::Models::Realtime::RealtimeResponse

The response resource.

Returns:



17
# File 'lib/openai/models/realtime/response_created_event.rb', line 17

required :response, -> { OpenAI::Realtime::RealtimeResponse }

#typeSymbol, :"response.created"

The event type, must be response.created.

Returns:



23
# File 'lib/openai/models/realtime/response_created_event.rb', line 23

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