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

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

Defined Under Namespace

Modules: Status

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:, arguments:, call_id:, created_at:, name:, output:, status:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.client_tool_call") ⇒ Object

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

Record of a client side tool invocation initiated by the assistant.

Parameters:

  • id (String) —

    Identifier of the thread item.

  • arguments (String) —

    JSON-encoded arguments that were sent to the tool.

  • call_id (String) —

    Identifier for the client tool call.

  • created_at (Integer) —

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

  • name (String) —

    Tool name that was invoked.

  • output (String, nil) —

    JSON-encoded output captured from the tool. Defaults to null while execution is

  • status (Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::Status) —

    Execution status for the tool call.

  • 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.client_tool_call") (defaults to: :"chatkit.client_tool_call") —

    Type discriminator that is always ‘chatkit.client_tool_call`.




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

Instance Attribute Details

#arguments ⇒ String

JSON-encoded arguments that were sent to the tool.

Returns:

  • (String) 


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

required :arguments, String

#call_id ⇒ String

Identifier for the client tool call.

Returns:

  • (String) 


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

required :call_id, String

#created_at ⇒ Integer

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

Returns:

  • (Integer) 


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

required :created_at, Integer

#id ⇒ String

Identifier of the thread item.

Returns:

  • (String) 


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

required :id, String

#name ⇒ String

Tool name that was invoked.

Returns:

  • (String) 


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

required :name, String

#object ⇒ Symbol, :"chatkit.thread_item"

Type discriminator that is always ‘chatkit.thread_item`.

Returns:

  • (Symbol, :"chatkit.thread_item") 


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

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

#output ⇒ String?

JSON-encoded output captured from the tool. Defaults to null while execution is in progress.

Returns:

  • (String, nil) 


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

required :output, String, nil?: true

#status ⇒ Symbol, OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::Status

Execution status for the tool call.

Returns:



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

required :status,
enum: -> { OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::Status }

#thread_id ⇒ String

Identifier of the parent thread.

Returns:

  • (String) 


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

required :thread_id, String

#type ⇒ Symbol, :"chatkit.client_tool_call"

Type discriminator that is always ‘chatkit.client_tool_call`.

Returns:

  • (Symbol, :"chatkit.client_tool_call") 


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

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