Class: OpenAI::Models::Responses::Response::PromptCacheOptions

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

Overview

See Also:

  • OpenAI::Models::Responses::Response#prompt_cache_options

Defined Under Namespace

Modules: Mode, Ttl

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

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(mode:, ttl:, comparison_response_id: nil) ⇒ Object

Parameters:

  • mode

    Whether implicit prompt-cache breakpoints were enabled.

  • ttl

    The minimum lifetime applied to each cache breakpoint.

  • comparison_response_id (defaults to: nil)

    The response ID supplied as the prompt cache diagnostics comparison.



# File 'lib/openai/models/responses/response.rb', line 1165

Instance Attribute Details

#comparison_response_idString?

The response ID supplied as the prompt cache diagnostics comparison.

Returns:

  • (String, nil)


1163
# File 'lib/openai/models/responses/response.rb', line 1163

optional :comparison_response_id, String, nil?: true

#modeOpenAI::Models::Responses::Response::PromptCacheOptions::mode

Whether implicit prompt-cache breakpoints were enabled.

Returns:

  • (OpenAI::Models::Responses::Response::PromptCacheOptions::mode)


1151
# File 'lib/openai/models/responses/response.rb', line 1151

required :mode, enum: -> { OpenAI::Responses::Response::PromptCacheOptions::Mode }

#ttlOpenAI::Models::Responses::Response::PromptCacheOptions::ttl

The minimum lifetime applied to each cache breakpoint.

Returns:

  • (OpenAI::Models::Responses::Response::PromptCacheOptions::ttl)


1157
# File 'lib/openai/models/responses/response.rb', line 1157

required :ttl, enum: -> { OpenAI::Responses::Response::PromptCacheOptions::Ttl }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/openai/models/responses/response.rb', line 1187

Instance Method Details

#to_hash{

Returns:

  • ({)


1089
# File 'sig/openai/models/responses/response.rbs', line 1089

def to_hash: -> {