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

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

Defined Under Namespace

Modules: Role, Status, Type

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(content:, role:, status: nil, type: nil) ⇒ Object

Parameters:

  • content —

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

  • role —

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

  • status (defaults to: nil) —

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

  • type (defaults to: nil) —

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




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

Instance Attribute Details

#content ⇒ OpenAI::Models::Responses::response_input_message_content_list

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

Returns:

  • (OpenAI::Models::Responses::response_input_message_content_list) 


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

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

#role ⇒ OpenAI::Models::Responses::ResponseInputItem::Message::role

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

Returns:

  • (OpenAI::Models::Responses::ResponseInputItem::Message::role) 


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

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

#status ⇒ OpenAI::Models::Responses::ResponseInputItem::Message::status?

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

Returns:

  • (OpenAI::Models::Responses::ResponseInputItem::Message::status, nil) 


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

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

#type ⇒ OpenAI::Models::Responses::ResponseInputItem::Message::type_?

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

Returns:

  • (OpenAI::Models::Responses::ResponseInputItem::Message::type_, nil) 


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

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 181

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


93
 
# File 'sig/openai/models/responses/response_input_item.rbs', line 93

def to_hash: -> {