Class: Vellum::TerminalNodeJsonResult

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, name:, type:, value:, additional_properties: nil) ⇒ Vellum::TerminalNodeJsonResult

Parameters:

  • id (String) (defaults to: OMIT)
  • name (String) —

    The unique name given to the terminal node that produced this output.

  • type (String)
  • value (Object)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 29

def initialize(id: OMIT, name:, type:, value:, additional_properties: nil)
  @id = id if id != OMIT
  @name = name
  @type = type
  @value = value
  @additional_properties = additional_properties
  @_field_set = { "id": id, "name": name, "type": type, "value": value }.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



16
17
18
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 16

def additional_properties
  @additional_properties
end

#id ⇒ String (readonly)

Returns:

  • (String) 


8
9
10
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 8

def id
  @id
end

#name ⇒ String (readonly)

Returns The unique name given to the terminal node that produced this output.

Returns:

  • (String) —

    The unique name given to the terminal node that produced this output.



10
11
12
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 10

def name
  @name
end

#type ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 12

def type
  @type
end

#value ⇒ Object (readonly)

Returns:

  • (Object) 


14
15
16
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 14

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::TerminalNodeJsonResult

Parameters:

  • json_object (String)

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 43

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


70
71
72
73
74
75
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 70

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


61
62
63
 
# File 'lib/vellum_ai/types/terminal_node_json_result.rb', line 61

def to_json
  @_field_set&.to_json
end