Class: OpenAI::Models::BatchListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::BatchListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/batch_list_params.rb

Overview

See Also:

• Resources::Batches#list

Instance Attribute Summary

• #after ⇒ String^?

  A cursor for use in pagination.

• #limit ⇒ Integer^?

  A limit on the number of objects to be returned.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(after: nil, limit: nil, request_options: {}) ⇒ Object constructor

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

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

Parameters:

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

  A cursor for use in pagination. ‘after` is an object ID that defines your place

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

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

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

# File 'lib/openai/models/batch_list_params.rb', line 26

Instance Attribute Details

#after ⇒ String^?

A cursor for use in pagination. ‘after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Returns:

• (String, nil)

# File 'lib/openai/models/batch_list_params.rb', line 17

optional :after, String

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

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

optional :limit, Integer