Class: OpenAI::Models::Responses::ResponseInputItem::Message

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_input_item.rb

Defined Under Namespace

Modules: Role, Status, Type

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, 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: , role: , status: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseInputItem::Message for more details.

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the ‘developer` or `system` role take precedence over instructions given with the `user` role.

Parameters:




# File 'lib/openai/models/responses/response_input_item.rb', line 116

Instance Attribute Details

#content ⇒ Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>

A list of one or many input items to the model, containing different content types.

Returns:



92
93
94
95
 
# File 'lib/openai/models/responses/response_input_item.rb', line 92

required :content,
-> {
  OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputContent]
}

#role ⇒ Symbol, OpenAI::Models::Responses::ResponseInputItem::Message::Role

The role of the message input. One of ‘user`, `system`, or `developer`.

Returns:



101
 
# File 'lib/openai/models/responses/response_input_item.rb', line 101

required :role, enum: -> { OpenAI::Responses::ResponseInputItem::Message::Role }

#status ⇒ Symbol, ...

The status of item. One of ‘in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.

Returns:



108
 
# File 'lib/openai/models/responses/response_input_item.rb', line 108

optional :status, enum: -> { OpenAI::Responses::ResponseInputItem::Message::Status }

#type ⇒ Symbol, ...

The type of the message input. Always set to ‘message`.

Returns:



114
 
# File 'lib/openai/models/responses/response_input_item.rb', line 114

optional :type, enum: -> { OpenAI::Responses::ResponseInputItem::Message::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response_input_item.rb', line 142