Class: Vellum::FunctionCall

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/function_call.rb

Overview

The final resolved function call value.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments:, id: OMIT, name:, additional_properties: nil) ⇒ Vellum::FunctionCall

Parameters:

  • arguments (Hash{String => Object})
  • id (String) (defaults to: OMIT)
  • name (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
34
35
 
# File 'lib/vellum_ai/types/function_call.rb', line 27

def initialize(arguments:, id: OMIT, name:, additional_properties: nil)
  @arguments = arguments
  @id = id if id != OMIT
  @name = name
  @additional_properties = additional_properties
  @_field_set = { "arguments": arguments, "id": id, "name": name }.reject do | _k, v |
  v == OMIT
end
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



15
16
17
 
# File 'lib/vellum_ai/types/function_call.rb', line 15

def additional_properties
  @additional_properties
end

#arguments ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


9
10
11
 
# File 'lib/vellum_ai/types/function_call.rb', line 9

def arguments
  @arguments
end

#id ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vellum_ai/types/function_call.rb', line 11

def id
  @id
end

#name ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/vellum_ai/types/function_call.rb', line 13

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::FunctionCall

Parameters:

  • json_object (String)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/vellum_ai/types/function_call.rb', line 40

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


65
66
67
68
69
 
# File 'lib/vellum_ai/types/function_call.rb', line 65

def self.validate_raw(obj:)
  obj.arguments.is_a?(Hash) != false || raise("Passed value for field obj.arguments is not the expected type, validation failed.")
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id 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 ⇒ String

Returns:

  • (String) 


56
57
58
 
# File 'lib/vellum_ai/types/function_call.rb', line 56

def to_json
  @_field_set&.to_json
end