Module: OpenAI::Models::Beta::RunStepStreamEvent

Extended by:

Internal::Type::Union

Defined in:

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

Overview

Occurs when a run step is created.

Defined Under Namespace

Classes: ThreadRunStepCancelled, ThreadRunStepCompleted, ThreadRunStepCreated, ThreadRunStepDelta, ThreadRunStepExpired, ThreadRunStepFailed, ThreadRunStepInProgress

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCreated, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepInProgress, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepDelta, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCompleted, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepFailed, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCancelled, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepExpired)

Instance Method Summary

• #initialize(data:, event: :"thread.run.step.cancelled") ⇒ Object

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

• #self?.variants ⇒ ::Array[OpenAI::Models::Beta::run_step_stream_event]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCreated, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepInProgress, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepDelta, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCompleted, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepFailed, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCancelled, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepExpired)

Returns:

• (Array(OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCreated, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepInProgress, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepDelta, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCompleted, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepFailed, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepCancelled, OpenAI::Models::Beta::RunStepStreamEvent::ThreadRunStepExpired))

# File 'lib/openai/models/beta/run_step_stream_event.rb', line 217

Instance Method Details

#initialize(data:, event: :"thread.run.step.cancelled") ⇒ Object

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

Occurs when a run step is cancelled.

Parameters:

• data (OpenAI::Models::Beta::Threads::Runs::RunStep) —

  Represents a step in execution of a run.

• event (Symbol, :"thread.run.step.cancelled") (defaults to: :"thread.run.step.cancelled")

# File 'lib/openai/models/beta/run_step_stream_event.rb', line 47

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::run_step_stream_event]

Returns:

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

# File 'sig/openai/models/beta/run_step_stream_event.rbs', line 170

def self?.variants: -> ::Array[OpenAI::Models::Beta::run_step_stream_event]