Class: OpenAI::Models::Live::InitialItem::Assistant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/live/initial_item.rb,
sig/openai/models/live/initial_item.rbs

Defined Under Namespace

Modules: Content, Status, Type

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(text:, type: :output_text) ⇒ Object

Assistant output text supplied as conversation history when starting a Live session.

Parameters:

  • text (String) —

    The message text to include in the Live session’s initial conversation history.

  • type (Symbol, :output_text) (defaults to: :output_text) —

    The text content type. Always output_text.




# File 'lib/openai/models/live/initial_item.rb', line 291

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Live::InitialItem::Assistant::Content::Text, OpenAI::Models::Live::InitialItem::Assistant::Content::OutputText>

The message content. Supply exactly one text part for the initial Live conversation history.

Parameters:

  • value (::Array[OpenAI::Models::Live::InitialItem::Assistant::content])

Returns:



260
261
262
263
 
# File 'lib/openai/models/live/initial_item.rb', line 260

required(
  :content,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Live::InitialItem::Assistant::Content] }
)

#id ⇒ String?

An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


276
 
# File 'lib/openai/models/live/initial_item.rb', line 276

optional :id, String, nil?: true

#role ⇒ Symbol, :assistant

The author of this history message. Always assistant.

Parameters:

  • value (:assistant)

Returns:

  • (Symbol, :assistant) 


269
 
# File 'lib/openai/models/live/initial_item.rb', line 269

required :role, const: :assistant

#status ⇒ Symbol, ...

The supplied message’s status. Live uses its text as history and does not resume an incomplete message.

Parameters:

  • value (OpenAI::Models::Live::InitialItem::Assistant::status, nil)

Returns:



283
 
# File 'lib/openai/models/live/initial_item.rb', line 283

optional :status, enum: -> { OpenAI::Live::InitialItem::Assistant::Status }, nil?: true

#type ⇒ Symbol, ...

The history item type. Always message.

Returns:



289
 
# File 'lib/openai/models/live/initial_item.rb', line 289

optional :type, enum: -> { OpenAI::Live::InitialItem::Assistant::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/live/initial_item.rb', line 397

.variants ⇒ Array(OpenAI::Models::Live::InitialItem::Assistant::Content::Text, OpenAI::Models::Live::InitialItem::Assistant::Content::OutputText)

Returns:




# File 'lib/openai/models/live/initial_item.rb', line 383

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


240
 
# File 'sig/openai/models/live/initial_item.rbs', line 240

def to_hash: -> {