Class: OpenAI::Models::Responses::ResponseInputMessageItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_input_message_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(id: , content: , role: , status: nil, type: nil) ⇒ Object

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

Parameters:




# File 'lib/openai/models/responses/response_input_message_item.rb', line 42

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:



18
19
20
21
 
# File 'lib/openai/models/responses/response_input_message_item.rb', line 18

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

#id ⇒ String

The unique ID of the message input.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_input_message_item.rb', line 11

required :id, String

#role ⇒ Symbol, OpenAI::Models::Responses::ResponseInputMessageItem::Role

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

Returns:



27
 
# File 'lib/openai/models/responses/response_input_message_item.rb', line 27

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

#status ⇒ Symbol, ...

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

Returns:



34
 
# File 'lib/openai/models/responses/response_input_message_item.rb', line 34

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

#type ⇒ Symbol, ...

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

Returns:



40
 
# File 'lib/openai/models/responses/response_input_message_item.rb', line 40

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response_input_message_item.rb', line 66