Class: Vellum::StreamingWorkflowNodeResultEvent

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

Overview

An event that indicates that the node has execution is in progress.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, node_id:, node_result_id:, ts: nil, data: nil, source_execution_id: nil, output: nil, output_index: nil, additional_properties: nil) ⇒ StreamingWorkflowNodeResultEvent

Parameters:

  • id (String)
  • node_id (String)
  • node_result_id (String)
  • ts (DateTime) (defaults to: nil)
  • data (WorkflowNodeResultData) (defaults to: nil)
  • source_execution_id (String) (defaults to: nil)
  • output (NodeOutputCompiledValue) (defaults to: nil)
  • output_index (Integer) (defaults to: nil)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/vellum_ai/types/streaming_workflow_node_result_event.rb', line 24

def initialize(id:, node_id:, node_result_id:, ts: nil, data: nil, source_execution_id: nil, output: nil,
               output_index: nil, additional_properties: nil)
  # @type [String]
  @id = id
  # @type [String]
  @node_id = node_id
  # @type [String]
  @node_result_id = node_result_id
  # @type [DateTime]
  @ts = ts
  # @type [WorkflowNodeResultData]
  @data = data
  # @type [String]
  @source_execution_id = source_execution_id
  # @type [NodeOutputCompiledValue]
  @output = output
  # @type [Integer]
  @output_index = output_index
  # @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.



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

def additional_properties
  @additional_properties
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#node_id ⇒ Object (readonly)

Returns the value of attribute node_id.



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

def node_id
  @node_id
end

#node_result_id ⇒ Object (readonly)

Returns the value of attribute node_result_id.



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

def node_result_id
  @node_result_id
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



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

def output
  @output
end

#output_index ⇒ Object (readonly)

Returns the value of attribute output_index.



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

def output_index
  @output_index
end

#source_execution_id ⇒ Object (readonly)

Returns the value of attribute source_execution_id.



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

def source_execution_id
  @source_execution_id
end

#ts ⇒ Object (readonly)

Returns the value of attribute ts.



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

def ts
  @ts
end

Class Method Details

.from_json(json_object:) ⇒ StreamingWorkflowNodeResultEvent

Deserialize a JSON object to an instance of StreamingWorkflowNodeResultEvent

Parameters:

  • json_object (JSON)

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/vellum_ai/types/streaming_workflow_node_result_event.rb', line 50

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = struct.id
  node_id = struct.node_id
  node_result_id = struct.node_result_id
  ts = DateTime.parse(parsed_json["ts"])
  if parsed_json["data"].nil?
    data = nil
  else
    data = parsed_json["data"].to_json
    data = WorkflowNodeResultData.from_json(json_object: data)
  end
  source_execution_id = struct.source_execution_id
  if parsed_json["output"].nil?
    output = nil
  else
    output = parsed_json["output"].to_json
    output = NodeOutputCompiledValue.from_json(json_object: output)
  end
  output_index = struct.output_index
  new(id: id, node_id: node_id, node_result_id: node_result_id, ts: ts, data: data,
      source_execution_id: source_execution_id, output: output, output_index: output_index, 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) 


95
96
97
98
99
100
101
102
103
104
 
# File 'lib/vellum_ai/types/streaming_workflow_node_result_event.rb', line 95

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.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
  obj.node_result_id.is_a?(String) != false || raise("Passed value for field obj.node_result_id is not the expected type, validation failed.")
  obj.ts&.is_a?(DateTime) != false || raise("Passed value for field obj.ts is not the expected type, validation failed.")
  obj.data.nil? || WorkflowNodeResultData.validate_raw(obj: obj.data)
  obj.source_execution_id&.is_a?(String) != false || raise("Passed value for field obj.source_execution_id is not the expected type, validation failed.")
  obj.output.nil? || NodeOutputCompiledValue.validate_raw(obj: obj.output)
  obj.output_index&.is_a?(Integer) != false || raise("Passed value for field obj.output_index is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of StreamingWorkflowNodeResultEvent to a JSON object

Returns:

  • (JSON) 


78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/vellum_ai/types/streaming_workflow_node_result_event.rb', line 78

def to_json(*_args)
  {
    "id": @id,
    "node_id": @node_id,
    "node_result_id": @node_result_id,
    "ts": @ts,
    "data": @data,
    "source_execution_id": @source_execution_id,
    "output": @output,
    "output_index": @output_index
  }.to_json
end