Class: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask

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

Defined Under Namespace

Modules: TaskType

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(id:, created_at:, heading:, summary:, task_type:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.task") ⇒ Object

Task emitted by the workflow to show progress and status updates.

Parameters:

  • id (String) —

    Identifier of the thread item.

  • created_at (Integer) —

    Unix timestamp (in seconds) for when the item was created.

  • heading (String, nil) —

    Optional heading for the task. Defaults to null when not provided.

  • summary (String, nil) —

    Optional summary that describes the task. Defaults to null when omitted.

  • task_type (Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::TaskType) —

    Subtype for the task.

  • thread_id (String) —

    Identifier of the parent thread.

  • object (Symbol, :"chatkit.thread_item") (defaults to: :"chatkit.thread_item") —

    Type discriminator that is always ‘chatkit.thread_item`.

  • type (Symbol, :"chatkit.task") (defaults to: :"chatkit.task") —

    Type discriminator that is always ‘chatkit.task`.




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

Instance Attribute Details

#created_at ⇒ Integer

Unix timestamp (in seconds) for when the item was created.

Returns:

  • (Integer) 


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

required :created_at, Integer

#heading ⇒ String?

Optional heading for the task. Defaults to null when not provided.

Returns:

  • (String, nil) 


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

required :heading, String, nil?: true

#id ⇒ String

Identifier of the thread item.

Returns:

  • (String) 


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

required :id, String

#object ⇒ Symbol, :"chatkit.thread_item"

Type discriminator that is always ‘chatkit.thread_item`.

Returns:

  • (Symbol, :"chatkit.thread_item") 


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

required :object, const: :"chatkit.thread_item"

#summary ⇒ String?

Optional summary that describes the task. Defaults to null when omitted.

Returns:

  • (String, nil) 


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

required :summary, String, nil?: true

#task_type ⇒ Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::TaskType

Subtype for the task.

Returns:



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

required :task_type,
enum: -> { OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::TaskType }

#thread_id ⇒ String

Identifier of the parent thread.

Returns:

  • (String) 


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

required :thread_id, String

#type ⇒ Symbol, :"chatkit.task"

Type discriminator that is always ‘chatkit.task`.

Returns:

  • (Symbol, :"chatkit.task") 


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

required :type, const: :"chatkit.task"