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,
sig/openai/models/beta/chatkit/chatkit_thread_item_list.rbs

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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

Parameters:

  • heading —

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

  • summary —

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

  • type —

    Subtype for the grouped task.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 356

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


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

required :heading, String, nil?: true

#summary ⇒ String?

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

Returns:

  • (String, nil) 


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

required :summary, String, nil?: true

#type ⇒ OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::type_

Subtype for the grouped task.

Returns:

  • (OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::type_) 


373
374
375
376
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_item_list.rb', line 373

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


349
 
# File 'sig/openai/models/beta/chatkit/chatkit_thread_item_list.rbs', line 349

def to_hash: -> {