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

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/responses/response_retrieve_params.rb

Overview

See Also:

• Resources::Responses#retrieve
• Resources::Responses#retrieve_streaming

Instance Attribute Summary

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

  Additional fields to include in the response.

• #starting_after ⇒ Integer^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(include: nil, starting_after: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseRetrieveParams 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, 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(include: nil, starting_after: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Additional fields to include in the response. See the ‘include`

• 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 26

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:

• (Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil)

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

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

#starting_after ⇒ Integer^?

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

Returns:

• (Integer, nil)

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

optional :starting_after, Integer