Class: OpenAI::Models::Responses::ResponseCompactParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseCompactParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/responses/response_compact_params.rb

Overview

See Also:

• Resources::Responses#compact

Defined Under Namespace

Modules: Input, Model

Instance Attribute Summary

• #input ⇒ String, ...

  Text, image, or file inputs to the model, used to generate a response.

• #instructions ⇒ String^?

  A system (or developer) message inserted into the model’s context.

• #model ⇒ Symbol, ...

  Model ID used to generate the response, like ‘gpt-5` or `o3`.

• #previous_response_id ⇒ String^?

  The unique ID of the previous response to the model.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(model:, input: nil, instructions: nil, previous_response_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseCompactParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(model:, input: nil, instructions: nil, previous_response_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• model (Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil) —

  Model ID used to generate the response, like ‘gpt-5` or `o3`. OpenAI offers a wi

• input (String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil) (defaults to: nil) —

  Text, image, or file inputs to the model, used to generate a response

• instructions (String, nil) (defaults to: nil) —

  A system (or developer) message inserted into the model’s context.

• previous_response_id (String, nil) (defaults to: nil) —

  The unique ID of the previous response to the model. Use this to create multi-tu

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/openai/models/responses/response_compact_params.rb', line 45

Instance Attribute Details

#input ⇒ String, ...

Text, image, or file inputs to the model, used to generate a response

Returns:

• (String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil)

# File 'lib/openai/models/responses/response_compact_params.rb', line 25

optional :input, union: -> { OpenAI::Responses::ResponseCompactParams::Input }, nil?: true

#instructions ⇒ String^?

A system (or developer) message inserted into the model’s context. When used along with ‘previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

Returns:

• (String, nil)

# File 'lib/openai/models/responses/response_compact_params.rb', line 34

optional :instructions, String, nil?: true

#model ⇒ Symbol, ...

Model ID used to generate the response, like ‘gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](platform.openai.com/docs/models) to browse and compare available models.

Returns:

• (Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil)

# File 'lib/openai/models/responses/response_compact_params.rb', line 19

required :model, union: -> { OpenAI::Responses::ResponseCompactParams::Model }, nil?: true

#previous_response_id ⇒ String^?

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with ‘conversation`.

Returns:

• (String, nil)

# File 'lib/openai/models/responses/response_compact_params.rb', line 43

optional :previous_response_id, String, nil?: true