Class: OpenAI::Models::Beta::BetaCompactedResponse

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

Overview

See Also:

  • OpenAI::Resources::Beta::Responses#compact

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 ⇒ Object 



26
 
# File 'sig/openai/models/beta/beta_compacted_response.rbs', line 26

def initialize: (

Instance Attribute Details

#created_at ⇒ Integer

Unix timestamp (in seconds) when the compacted conversation was created.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :created_at, Integer

#id ⇒ String

The unique identifier for the compacted response.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#object ⇒ Symbol, :"response.compaction"

The object type. Always response.compaction.

Parameters:

  • value (:"response.compaction")

Returns:

  • (Symbol, :"response.compaction") 


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

required :object, const: :"response.compaction"

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

The compacted list of output items. This is a list of all user messages, followed by a single compaction item.

Parameters:

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

Returns:



31
 
# File 'lib/openai/models/beta/beta_compacted_response.rb', line 31

required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseOutputItem] }

#usage ⇒ OpenAI::Models::Beta::BetaResponseUsage

Token accounting for the compaction pass, including cached, reasoning, and total tokens.

Parameters:

  • value (OpenAI::Beta::BetaResponseUsage)

Returns:



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

required :usage, -> { OpenAI::Beta::BetaResponseUsage }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/beta/beta_compacted_response.rbs', line 34

def to_hash: -> {