Class: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb

Defined Under Namespace

Modules: Data

Instance Attribute Summary collapse

Instance Method Summary collapse

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(data:, first_id:, has_more:, last_id:, object: :list) ⇒ Object

A paginated list of thread items rendered for the ChatKit API.

Parameters:




# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 39

Instance Attribute Details

#data ⇒ Array<OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadAssistantMessageItem, OpenAI::Models::Beta::ChatKit::ChatKitWidgetItem, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup>

A list of items

Returns:



12
13
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 12

required :data,
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data] }

#first_id ⇒ String?

The ID of the first item in the list.

Returns:

  • (String, nil) 


19
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 19

required :first_id, String, nil?: true

#has_more ⇒ Boolean

Whether there are more items available.

Returns:



25
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 25

required :has_more, OpenAI::Internal::Type::Boolean

#last_id ⇒ String?

The ID of the last item in the list.

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 31

required :last_id, String, nil?: true

#object ⇒ Symbol, :list

The type of object returned, must be ‘list`.

Returns:

  • (Symbol, :list) 


37
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 37

required :object, const: :list