Class: OpenAI::Models::VectorStores::FileListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Filter, Order

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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, filter: nil, limit: nil, order: nil, request_options: {}) ⇒ Object

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

Parameters:

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

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

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

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

  • filter (Symbol, OpenAI::Models::VectorStores::FileListParams::Filter) (defaults to: nil) —

    Filter by file status. One of ‘in_progress`, `completed`, `failed`, `cancelled`.

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

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

  • order (Symbol, OpenAI::Models::VectorStores::FileListParams::Order) (defaults to: nil) —

    Sort order by the ‘created_at` timestamp of the objects. `asc` for ascending ord

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



# File 'lib/openai/models/vector_stores/file_list_params.rb', line 49

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) 


18
 
# File 'lib/openai/models/vector_stores/file_list_params.rb', line 18

optional :after, String

#before ⇒ String?

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

Returns:

  • (String, nil) 


27
 
# File 'lib/openai/models/vector_stores/file_list_params.rb', line 27

optional :before, String

#filter ⇒ Symbol, ...

Filter by file status. One of ‘in_progress`, `completed`, `failed`, `cancelled`.

Returns:



33
 
# File 'lib/openai/models/vector_stores/file_list_params.rb', line 33

optional :filter, enum: -> { OpenAI::VectorStores::FileListParams::Filter }

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


40
 
# File 'lib/openai/models/vector_stores/file_list_params.rb', line 40

optional :limit, Integer

#order ⇒ Symbol, ...

Sort order by the ‘created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

Returns:



47
 
# File 'lib/openai/models/vector_stores/file_list_params.rb', line 47

optional :order, enum: -> { OpenAI::VectorStores::FileListParams::Order }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/vector_stores/file_list_params.rb', line 74