Class: OpenAI::Models::Conversations::ConversationItem::ProgramOutput

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/conversations/conversation_item.rb

Defined Under Namespace

Modules: Status

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, 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(id:, call_id:, result:, status:, type: :program_output) ⇒ Object

Parameters:

  • id (String) —

    The unique ID of the program output item.

  • call_id (String) —

    The call ID of the program item.

  • result (String) —

    The result produced by the program item.

  • status (Symbol, OpenAI::Models::Conversations::ConversationItem::ProgramOutput::Status) —

    The terminal status of the program output item.

  • type (Symbol, :program_output) (defaults to: :program_output) —

    The type of the item. Always program_output.




# File 'lib/openai/models/conversations/conversation_item.rb', line 284

Instance Attribute Details

#call_id ⇒ String

The call ID of the program item.

Returns:

  • (String) 


264
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 264

required :call_id, String

#id ⇒ String

The unique ID of the program output item.

Returns:

  • (String) 


258
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 258

required :id, String

#result ⇒ String

The result produced by the program item.

Returns:

  • (String) 


270
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 270

required :result, String

#status ⇒ Symbol, OpenAI::Models::Conversations::ConversationItem::ProgramOutput::Status

The terminal status of the program output item.

Returns:



276
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 276

required :status, enum: -> { OpenAI::Conversations::ConversationItem::ProgramOutput::Status }

#type ⇒ Symbol, :program_output

The type of the item. Always program_output.

Returns:

  • (Symbol, :program_output) 


282
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 282

required :type, const: :program_output