Class: OpenAI::Models::Beta::BetaResponseInProgressEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaResponseInProgressEvent

Defined in:

lib/openai/models/beta/beta_response_in_progress_event.rb,
sig/openai/models/beta/beta_response_in_progress_event.rbs

Defined Under Namespace

Classes: Agent

Instance Attribute Summary

• #agent ⇒ OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent^?

  The agent that owns this multi-agent streaming event.

• #response ⇒ OpenAI::Models::Beta::BetaResponse

  The response that is in progress.

• #sequence_number ⇒ Integer

  The sequence number of this event.

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

  The type of the event.

Instance Method Summary

• #initialize(response:, sequence_number:, agent: nil, type: :"response.in_progress") ⇒ Object constructor

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

• #to_hash ⇒ {

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(response:, sequence_number:, agent: nil, type: :"response.in_progress") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseInProgressEvent for more details.

Emitted when the response is in progress.

Parameters:

• response (OpenAI::Models::Beta::BetaResponse) —

  The response that is in progress.

• sequence_number (Integer) —

  The sequence number of this event.

• agent (OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent, nil) (defaults to: nil) —

  The agent that owns this multi-agent streaming event.

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

  The type of the event. Always response.in_progress.

# File 'lib/openai/models/beta/beta_response_in_progress_event.rb', line 31

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent^?

The agent that owns this multi-agent streaming event.

Parameters:

• value (OpenAI::Beta::BetaResponseInProgressEvent::Agent, nil)

Returns:

• (OpenAI::Models::Beta::BetaResponseInProgressEvent::Agent, nil)

# File 'lib/openai/models/beta/beta_response_in_progress_event.rb', line 29

optional :agent, -> { OpenAI::Beta::BetaResponseInProgressEvent::Agent }, nil?: true

#response ⇒ OpenAI::Models::Beta::BetaResponse

The response that is in progress.

Parameters:

• value (OpenAI::Beta::BetaResponse)

Returns:

• (OpenAI::Models::Beta::BetaResponse)

# File 'lib/openai/models/beta/beta_response_in_progress_event.rb', line 11

required :response, -> { OpenAI::Beta::BetaResponse }

#sequence_number ⇒ Integer

The sequence number of this event.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/openai/models/beta/beta_response_in_progress_event.rb', line 17

required :sequence_number, Integer

#type ⇒ Symbol, :"response.in_progress"

The type of the event. Always response.in_progress.

Parameters:

• value (:"response.in_progress")

Returns:

• (Symbol, :"response.in_progress")

# File 'lib/openai/models/beta/beta_response_in_progress_event.rb', line 23

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/beta_response_in_progress_event.rbs', line 30

def to_hash: -> {