Class: Vellum::MapNodeResult

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

Overview

A Node Result Event emitted from a Map Node.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, data: OMIT, additional_properties: nil) ⇒ Vellum::MapNodeResult

Parameters:

  • type (String)
  • data (Vellum::MapNodeResultData) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/vellum_ai/types/map_node_result.rb', line 25

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



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

def additional_properties
  @additional_properties
end

#data ⇒ Vellum::MapNodeResultData (readonly)

Returns:



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

def data
  @data
end

#type ⇒ String (readonly)

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::MapNodeResult

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  type = parsed_json["type"]
  unless parsed_json["data"].nil?
    data = parsed_json["data"].to_json
    data = Vellum::MapNodeResultData.from_json(json_object: data)
  else
    data = nil
  end
  new(
    type: type,
    data: data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end