Class: OpenAI::Models::Responses::ResponseCompletedEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseCompletedEvent

Defined in:

lib/openai/models/responses/response_completed_event.rb

Instance Attribute Summary

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

  Properties of the completed response.

• #sequence_number ⇒ Integer

  The sequence number for this event.

• #type ⇒ Symbol, :"response.completed"

  The type of the event.

Instance Method Summary

• #initialize(response: , sequence_number: , type: :"response.completed") ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseCompletedEvent for more details.

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.completed") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseCompletedEvent for more details.

Emitted when the model response is complete.

Parameters:

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

  Properties of the completed response.

• sequence_number (Integer) (defaults to: ) —

  The sequence number for this event.

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

  The type of the event. Always ‘response.completed`.

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

Instance Attribute Details

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

Properties of the completed response.

Returns:

• (OpenAI::Models::Responses::Response)

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

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

#sequence_number ⇒ Integer

The sequence number for this event.

Returns:

• (Integer)

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

required :sequence_number, Integer

#type ⇒ Symbol, :"response.completed"

The type of the event. Always ‘response.completed`.

Returns:

• (Symbol, :"response.completed")

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

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