Class: OpenAI::Models::Beta::Threads::MessageDeltaEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::Threads::MessageDeltaEvent

Defined in:

lib/openai/models/beta/threads/message_delta_event.rb

Instance Attribute Summary

• #delta ⇒ OpenAI::Models::Beta::Threads::MessageDelta

  The delta containing the fields that have changed on the Message.

• #id ⇒ String

  The identifier of the message, which can be referenced in API endpoints.

• #object ⇒ Symbol, :"thread.message.delta"

  The object type, which is always ‘thread.message.delta`.

Instance Method Summary

• #initialize(id: , delta: , object: :"thread.message.delta") ⇒ Object constructor

  Represents a message delta i.e.

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(id: , delta: , object: :"thread.message.delta") ⇒ Object

Represents a message delta i.e. any changed fields on a message during streaming.

Parameters:

• id (String) (defaults to: ) —

  The identifier of the message, which can be referenced in API endpoints.

• delta (OpenAI::Models::Beta::Threads::MessageDelta) (defaults to: ) —

  The delta containing the fields that have changed on the Message.

• object (Symbol, :"thread.message.delta") (defaults to: :"thread.message.delta") —

  The object type, which is always ‘thread.message.delta`.

# File 'lib/openai/models/beta/threads/message_delta_event.rb', line 26

Instance Attribute Details

#delta ⇒ OpenAI::Models::Beta::Threads::MessageDelta

The delta containing the fields that have changed on the Message.

Returns:

• (OpenAI::Models::Beta::Threads::MessageDelta)

# File 'lib/openai/models/beta/threads/message_delta_event.rb', line 18

required :delta, -> { OpenAI::Beta::Threads::MessageDelta }

#id ⇒ String

The identifier of the message, which can be referenced in API endpoints.

Returns:

• (String)

# File 'lib/openai/models/beta/threads/message_delta_event.rb', line 12

required :id, String

#object ⇒ Symbol, :"thread.message.delta"

The object type, which is always ‘thread.message.delta`.

Returns:

• (Symbol, :"thread.message.delta")

# File 'lib/openai/models/beta/threads/message_delta_event.rb', line 24

required :object, const: :"thread.message.delta"