Class: OpenAI::Models::Beta::BetaResponseInputMessageItem

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

Defined Under Namespace

Modules: Role, Status Classes: Agent

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(agent_name:) ⇒ Object

The agent that produced this item.

Parameters:

  • agent_name (String) —

    The canonical name of the agent that produced this item.




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

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseInputMessageItem::Agent?

The agent that produced this item.

Parameters:

  • value (OpenAI::Beta::BetaResponseInputMessageItem::Agent, nil)

Returns:



36
 
# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 36

optional :agent, -> { OpenAI::Beta::BetaResponseInputMessageItem::Agent }, nil?: true

#content ⇒ Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>

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

Parameters:

  • value (OpenAI::Models::Beta::beta_response_input_message_content_list)

Returns:



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

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

#id ⇒ String

The unique ID of the message input.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 11

required :id, String

#role ⇒ Symbol, OpenAI::Models::Beta::BetaResponseInputMessageItem::Role

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

Parameters:

  • value (OpenAI::Models::Beta::BetaResponseInputMessageItem::role)

Returns:



24
 
# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 24

required :role, enum: -> { OpenAI::Beta::BetaResponseInputMessageItem::Role }

#status ⇒ Symbol, ...

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

Returns:



43
 
# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 43

optional :status, enum: -> { OpenAI::Beta::BetaResponseInputMessageItem::Status }

#type ⇒ Symbol, :message

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

Parameters:

  • value (:message)

Returns:

  • (Symbol, :message) 


30
 
# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 30

required :type, const: :message

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/beta_response_input_message_item.rb', line 71

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


42
 
# File 'sig/openai/models/beta/beta_response_input_message_item.rbs', line 42

def to_hash: -> {