Class: OpenAI::Models::Chat::ChatCompletionUserMessageParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/chat/chat_completion_user_message_param.rb

Defined Under Namespace

Modules: Content

Instance Attribute 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, 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(content: , name: nil, role: :user) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Chat::ChatCompletionUserMessageParam for more details.

Messages sent by an end user, containing prompts or additional context information.

Parameters:




# File 'lib/openai/models/chat/chat_completion_user_message_param.rb', line 26

Instance Attribute Details

#content ⇒ String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage, OpenAI::Models::Chat::ChatCompletionContentPartInputAudio, OpenAI::Models::Chat::ChatCompletionContentPart::File>

The contents of the user message.

Returns:



11
 
# File 'lib/openai/models/chat/chat_completion_user_message_param.rb', line 11

required :content, union: -> { OpenAI::Chat::ChatCompletionUserMessageParam::Content }

#name ⇒ String?

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Returns:

  • (String, nil) 


24
 
# File 'lib/openai/models/chat/chat_completion_user_message_param.rb', line 24

optional :name, String

#role ⇒ Symbol, :user

The role of the messages author, in this case ‘user`.

Returns:

  • (Symbol, :user) 


17
 
# File 'lib/openai/models/chat/chat_completion_user_message_param.rb', line 17

required :role, const: :user