Class: Vellum::PromptNodeResult

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

Overview

A Node Result Event emitted from a Prompt Node.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data:, additional_properties: nil) ⇒ PromptNodeResult

Parameters:

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

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
 
# File 'lib/vellum_ai/types/prompt_node_result.rb', line 14

def initialize(data:, additional_properties: nil)
  # @type [PromptNodeResultData]
  @data = data
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

Class Method Details

.from_json(json_object:) ⇒ PromptNodeResult

Deserialize a JSON object to an instance of PromptNodeResult

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["data"].nil?
    data = nil
  else
    data = parsed_json["data"].to_json
    data = PromptNodeResultData.from_json(json_object: data)
  end
  new(data: data, 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) 


48
49
50
 
# File 'lib/vellum_ai/types/prompt_node_result.rb', line 48

def self.validate_raw(obj:)
  PromptNodeResultData.validate_raw(obj: obj.data)
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of PromptNodeResult to a JSON object

Returns:

  • (JSON) 


40
41
42
 
# File 'lib/vellum_ai/types/prompt_node_result.rb', line 40

def to_json(*_args)
  { "data": @data }.to_json
end