Class: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_conversation_item_user_message.rb

Defined Under Namespace

Modules: Object, Status Classes: Content

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>

The content of the message.

Returns:



11
12
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 11

required :content,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemUserMessage::Content] }

#id ⇒ String?

The unique ID of the item. This may be provided by the client or generated by the server.

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 31

optional :id, String

#object ⇒ Symbol, ...

Identifier for the API object being returned - always ‘realtime.item`. Optional when creating a new item.

Returns:



38
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 38

optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Object }

#role ⇒ Symbol, :user

The role of the message sender. Always ‘user`.

Returns:

  • (Symbol, :user) 


18
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 18

required :role, const: :user

#status ⇒ Symbol, ...

The status of the item. Has no effect on the conversation.

Returns:



44
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 44

optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Status }

#type ⇒ Symbol, :message

The type of the item. Always ‘message`.

Returns:

  • (Symbol, :message) 


24
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 24

required :type, const: :message

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 150