Class: OpenAI::Models::Responses::InputItemListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Order

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, 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(after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {}) ⇒ Object

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

Parameters:

  • after (String) (defaults to: nil) —

    An item ID to list items after, used in pagination.

  • before (String) (defaults to: nil) —

    An item ID to list items before, used in pagination.

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

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

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

    A limit on the number of objects to be returned. Limit can range between

  • order (Symbol, OpenAI::Models::Responses::InputItemListParams::Order) (defaults to: nil) —

    The order to return the input items in. Default is ‘desc`.

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



# File 'lib/openai/models/responses/input_item_list_params.rb', line 46

Instance Attribute Details

#after ⇒ String?

An item ID to list items after, used in pagination.

Returns:

  • (String, nil) 


15
 
# File 'lib/openai/models/responses/input_item_list_params.rb', line 15

optional :after, String

#before ⇒ String?

An item ID to list items before, used in pagination.

Returns:

  • (String, nil) 


21
 
# File 'lib/openai/models/responses/input_item_list_params.rb', line 21

optional :before, String

#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:



28
 
# File 'lib/openai/models/responses/input_item_list_params.rb', line 28

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

#limit ⇒ Integer?

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Returns:

  • (Integer, nil) 


35
 
# File 'lib/openai/models/responses/input_item_list_params.rb', line 35

optional :limit, Integer

#order ⇒ Symbol, ...

The order to return the input items in. Default is ‘desc`.

  • ‘asc`: Return the input items in ascending order.

  • ‘desc`: Return the input items in descending order.

Returns:



44
 
# File 'lib/openai/models/responses/input_item_list_params.rb', line 44

optional :order, enum: -> { OpenAI::Responses::InputItemListParams::Order }