Class: Vapi::ToolCallFunction

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/tool_call_function.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments:, name:, additional_properties: nil) ⇒ Vapi::ToolCallFunction

Parameters:

  • arguments (String) —

    This is the arguments to call the function with

  • name (String) —

    This is the name of the function to call

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 24

def initialize(arguments:, name:, additional_properties: nil)
  @arguments = arguments
  @name = name
  @additional_properties = additional_properties
  @_field_set = { "arguments": arguments, "name": name }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



13
14
15
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 13

def additional_properties
  @additional_properties
end

#arguments ⇒ String (readonly)

Returns This is the arguments to call the function with.

Returns:

  • (String) —

    This is the arguments to call the function with



9
10
11
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 9

def arguments
  @arguments
end

#name ⇒ String (readonly)

Returns This is the name of the function to call.

Returns:

  • (String) —

    This is the name of the function to call



11
12
13
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 11

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ToolCallFunction

Deserialize a JSON object to an instance of ToolCallFunction

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  arguments = parsed_json["arguments"]
  name = parsed_json["name"]
  new(
    arguments: arguments,
    name: name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


60
61
62
63
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 60

def self.validate_raw(obj:)
  obj.arguments.is_a?(String) != false || raise("Passed value for field obj.arguments is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ToolCallFunction to a JSON object

Returns:

  • (String) 


50
51
52
 
# File 'lib/vapi_server_sdk/types/tool_call_function.rb', line 50

def to_json(*_args)
  @_field_set&.to_json
end