Class: OpenAI::Models::Beta::ChatKit::ThreadListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::ChatKit::ThreadListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/beta/chatkit/thread_list_params.rb

Overview

See Also:

• Resources::Beta::ChatKit::Threads#list

Defined Under Namespace

Modules: Order

Instance Attribute Summary

• #after ⇒ String^?

  List items created after this thread item ID.

• #before ⇒ String^?

  List items created before this thread item ID.

• #limit ⇒ Integer^?

  Maximum number of thread items to return.

• #order ⇒ Symbol, ...

  Sort order for results by creation time.

• #user ⇒ String^?

  Filter threads that belong to this user identifier.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

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

Some parameter documentations has been truncated, see OpenAI::Models::Beta::ChatKit::ThreadListParams for more details.

Parameters:

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

  List items created after this thread item ID. Defaults to null for the first pag

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

  List items created before this thread item ID. Defaults to null for the newest r

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

  Maximum number of thread items to return. Defaults to 20.

• order (Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order) (defaults to: nil) —

  Sort order for results by creation time. Defaults to ‘desc`.

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

  Filter threads that belong to this user identifier. Defaults to null to return a

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

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 45

Instance Attribute Details

#after ⇒ String^?

List items created after this thread item ID. Defaults to null for the first page.

Returns:

• (String, nil)

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 17

optional :after, String

#before ⇒ String^?

List items created before this thread item ID. Defaults to null for the newest results.

Returns:

• (String, nil)

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 24

optional :before, String

#limit ⇒ Integer^?

Maximum number of thread items to return. Defaults to 20.

Returns:

• (Integer, nil)

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 30

optional :limit, Integer

#order ⇒ Symbol, ...

Sort order for results by creation time. Defaults to ‘desc`.

Returns:

• (Symbol, OpenAI::Models::Beta::ChatKit::ThreadListParams::Order, nil)

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 36

optional :order, enum: -> { OpenAI::Beta::ChatKit::ThreadListParams::Order }

#user ⇒ String^?

Filter threads that belong to this user identifier. Defaults to null to return all users.

Returns:

• (String, nil)

# File 'lib/openai/models/beta/chatkit/thread_list_params.rb', line 43

optional :user, String