Class: OpenAI::Models::Responses::CompactedResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/compacted_response.rb

Overview

See Also:

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:, created_at:, output:, usage:, object: :"response.compaction") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::CompactedResponse for more details.

Parameters:




# File 'lib/openai/models/responses/compacted_response.rb', line 40

Instance Attribute Details

#created_at ⇒ Integer

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

Returns:

  • (Integer) 


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

required :created_at, Integer

#id ⇒ String

The unique identifier for the compacted response.

Returns:

  • (String) 


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

required :id, String

#object ⇒ Symbol, :"response.compaction"

The object type. Always ‘response.compaction`.

Returns:

  • (Symbol, :"response.compaction") 


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

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

#output ⇒ Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>

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

Returns:



31
 
# File 'lib/openai/models/responses/compacted_response.rb', line 31

required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }

#usage ⇒ OpenAI::Models::Responses::ResponseUsage

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

Returns:



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

required :usage, -> { OpenAI::Responses::ResponseUsage }