Class: OpenAI::Models::Beta::Responses::BetaResponseItemList

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

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(data:, first_id:, has_more:, last_id:, object: :list) ⇒ Object

A list of Response items.

Parameters:




# File 'lib/openai/models/beta/responses/beta_response_item_list.rb', line 38

Instance Attribute Details

#data ⇒ Array<OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>

A list of items used to generate this response.

Parameters:

  • value (::Array[OpenAI::Models::Beta::beta_response_item])

Returns:



12
 
# File 'lib/openai/models/beta/responses/beta_response_item_list.rb', line 12

required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseItem] }

#first_id ⇒ String

The ID of the first item in the list.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :first_id, String

#has_more ⇒ Boolean

Whether there are more items available.

Parameters:

Returns:



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

required :has_more, OpenAI::Internal::Type::Boolean

#last_id ⇒ String

The ID of the last item in the list.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :last_id, String

#object ⇒ Symbol, :list

The type of object returned, must be list.

Parameters:

  • value (:list)

Returns:

  • (Symbol, :list) 


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

required :object, const: :list

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


33
 
# File 'sig/openai/models/beta/responses/beta_response_item_list.rbs', line 33

def to_hash: -> {