Class: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task

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

Defined Under Namespace

Modules: Type

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(heading:, summary:, type:) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task for more details.

Task entry that appears within a TaskGroup.

Parameters:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 317

class Task < OpenAI::Internal::Type::BaseModel
  # @!attribute heading
  #   Optional heading for the grouped task. Defaults to null when not provided.
  #
  #   @return [String, nil]
  required :heading, String, nil?: true

  # @!attribute summary
  #   Optional summary that describes the grouped task. Defaults to null when omitted.
  #
  #   @return [String, nil]
  required :summary, String, nil?: true

  # @!attribute type
  #   Subtype for the grouped task.
  #
  #   @return [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type]
  required :type,
           enum: -> { OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type }

  # @!method initialize(heading:, summary:, type:)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task}
  #   for more details.
  #
  #   Task entry that appears within a TaskGroup.
  #
  #   @param heading [String, nil] Optional heading for the grouped task. Defaults to null when not provided.
  #
  #   @param summary [String, nil] Optional summary that describes the grouped task. Defaults to null when omitted.
  #
  #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type] Subtype for the grouped task.

  # Subtype for the grouped task.
  #
  # @see OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task#type
  module Type
    extend OpenAI::Internal::Type::Enum

    CUSTOM = :custom
    THOUGHT = :thought

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#heading ⇒ String?

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

Returns:

  • (String, nil) 


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

required :heading, String, nil?: true

#summary ⇒ String?

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

Returns:

  • (String, nil) 


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

required :summary, String, nil?: true

#type ⇒ Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type

Subtype for the grouped task.

Returns:



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

required :type,
enum: -> { OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::Type }