Class: OpenAI::Models::Responses::ResponseRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/responses/response_retrieve_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(response_id:, include: nil, include_obfuscation: nil, starting_after: nil, request_options: {}) ⇒ Object

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

Parameters:

  • response_id (String)
  • include (Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>) (defaults to: nil) —

    Additional fields to include in the response. See the include

  • include_obfuscation (Boolean) (defaults to: nil) —

    When true, stream obfuscation will be enabled. Stream obfuscation adds

  • starting_after (Integer) (defaults to: nil) —

    The sequence number of the event after which to start streaming.

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



# File 'lib/openai/models/responses/response_retrieve_params.rb', line 42

Instance Attribute Details

#include ⇒ Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>?

Additional fields to include in the response. See the include parameter for Response creation above for more information.

Returns:



23
 
# File 'lib/openai/models/responses/response_retrieve_params.rb', line 23

optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }

#include_obfuscation ⇒ Boolean?

When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

Returns:



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

optional :include_obfuscation, OpenAI::Internal::Type::Boolean

#response_id ⇒ String

Returns:

  • (String) 


16
 
# File 'lib/openai/models/responses/response_retrieve_params.rb', line 16

required :response_id, String

#starting_after ⇒ Integer?

The sequence number of the event after which to start streaming.

Returns:

  • (Integer, nil) 


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

optional :starting_after, Integer