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

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

Overview

See Also:

  • OpenAI::Resources::Responses#compact

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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

Parameters:

  • id —

    The unique identifier for the compacted response.

  • created_at —

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

  • output —

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

  • usage —

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

  • object (defaults to: :"response.compaction") —

    The object type. Always response.compaction.




# 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 ⇒ :"response.compaction"

The object type. Always response.compaction.

Returns:

  • (:"response.compaction") 


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

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

#output ⇒ ::Array[OpenAI::Models::Responses::response_output_item]

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

Returns:

  • (::Array[OpenAI::Models::Responses::response_output_item]) 


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

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

#usage ⇒ OpenAI::Responses::ResponseUsage

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

Returns:

  • (OpenAI::Responses::ResponseUsage) 


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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


51
 
# File 'sig/openai/models/responses/compacted_response.rbs', line 51

def to_hash: -> {