Class: OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb

Defined Under Namespace

Modules: Content Classes: InferenceOptions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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, 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: :quoted_text) ⇒ Object

Quoted snippet that the user referenced in their message.

Parameters:

  • text (String) —

    Quoted text content.

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

    Type discriminator that is always ‘quoted_text`.




# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 58

Instance Attribute Details

#attachments ⇒ Array<OpenAI::Models::Beta::ChatKit::ChatKitAttachment>

Attachments associated with the user message. Defaults to an empty list.

Returns:



18
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 18

required :attachments, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ChatKit::ChatKitAttachment] }

#content ⇒ Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::InputText, OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::QuotedText>

Ordered content elements supplied by the user.

Returns:



24
25
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 24

required :content,
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::Content] }

#created_at ⇒ Integer

Unix timestamp (in seconds) for when the item was created.

Returns:

  • (Integer) 


31
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 31

required :created_at, Integer

#id ⇒ String

Identifier of the thread item.

Returns:

  • (String) 


12
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 12

required :id, String

#inference_options ⇒ OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions?

Inference overrides applied to the message. Defaults to null when unset.

Returns:



37
38
39
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 37

required :inference_options,
-> { OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions },
nil?: true

#object ⇒ Symbol, :"chatkit.thread_item"

Type discriminator that is always ‘chatkit.thread_item`.

Returns:

  • (Symbol, :"chatkit.thread_item") 


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

required :object, const: :"chatkit.thread_item"

#thread_id ⇒ String

Identifier of the parent thread.

Returns:

  • (String) 


51
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 51

required :thread_id, String

#type ⇒ Symbol, :"chatkit.user_message"

Returns:

  • (Symbol, :"chatkit.user_message") 


56
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 56

required :type, const: :"chatkit.user_message"

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::InputText, OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::Content::QuotedText)

Returns:




# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 131