Class: Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/calls/action_start_ai_assistant_params.rb

Defined Under Namespace

Modules: Type Classes: Function

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(name:) ⇒ Object

The function that the model called.

Parameters:

  • name (String) —

    The name of the function to call.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 234

class ToolCall < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #   The ID of the tool call.
  #
  #   @return [String]
  required :id, String

  # @!attribute function
  #   The function that the model called.
  #
  #   @return [Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function]
  required :function,
           -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function }

  # @!attribute type
  #   The type of the tool. Currently, only `function` is supported.
  #
  #   @return [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type]
  required :type,
           enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type }

  # @!method initialize(id:, function:, type:)
  #   A call to a function tool created by the model.
  #
  #   @param id [String] The ID of the tool call.
  #
  #   @param function [Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function] The function that the model called.
  #
  #   @param type [Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type] The type of the tool. Currently, only `function` is supported.

  # @see Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall#function
  class Function < Telnyx::Internal::Type::BaseModel
    # @!attribute name
    #   The name of the function to call.
    #
    #   @return [String]
    required :name, String

    # @!method initialize(name:)
    #   The function that the model called.
    #
    #   @param name [String] The name of the function to call.
  end

  # The type of the tool. Currently, only `function` is supported.
  #
  # @see Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall#type
  module Type
    extend Telnyx::Internal::Type::Enum

    FUNCTION = :function

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

Instance Attribute Details

#function ⇒ Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function

The function that the model called.

Returns:



245
246
 
# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 245

required :function,
-> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Function }

#id ⇒ String

The ID of the tool call.

Returns:

  • (String) 


239
 
# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 239

required :id, String

#type ⇒ Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type

The type of the tool. Currently, only ‘function` is supported.

Returns:



252
253
 
# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 252

required :type,
enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory::Assistant::ToolCall::Type }