Module: OpenAI::Models::Beta::MessageStreamEvent

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/beta/message_stream_event.rb

Overview

Occurs when a [message](platform.openai.com/docs/api-reference/messages/object) is created.

Defined Under Namespace

Classes: ThreadMessageCompleted, ThreadMessageCreated, ThreadMessageDelta, ThreadMessageInProgress, ThreadMessageIncomplete

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCreated, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageInProgress, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageDelta, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCompleted, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageIncomplete)

Instance Method Summary

• #initialize(data: , event: :"thread.message.completed") ⇒ Object

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

Methods included from Internal::Type::Union

==, ===, coerce, 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, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCreated, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageInProgress, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageDelta, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCompleted, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageIncomplete)

Returns:

• (Array(OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCreated, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageInProgress, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageDelta, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageCompleted, OpenAI::Models::Beta::MessageStreamEvent::ThreadMessageIncomplete))

# File 'lib/openai/models/beta/message_stream_event.rb', line 166

Instance Method Details

#initialize(data: , event: :"thread.message.completed") ⇒ Object

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

Occurs when a [message](platform.openai.com/docs/api-reference/messages/object) is completed.

Parameters:

• data (OpenAI::Models::Beta::Threads::Message) (defaults to: ) —

  Represents a message within a [thread](platform.openai.com/docs/api-refe

• event (Symbol, :"thread.message.completed") (defaults to: :"thread.message.completed")

# File 'lib/openai/models/beta/message_stream_event.rb', line 45