Class: Vellum::WorkflowOutputString

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

Overview

A string output from a Workflow execution.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, value: nil, additional_properties: nil) ⇒ WorkflowOutputString

Parameters:

  • id (String)
  • name (String) —

    The output’s name, as defined in the workflow

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

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/vellum_ai/types/workflow_output_string.rb', line 15

def initialize(id:, name:, value: nil, additional_properties: nil)
  # @type [String]
  @id = id
  # @type [String] The output's name, as defined in the workflow
  @name = name
  # @type [String]
  @value = value
  # @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.



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

def additional_properties
  @additional_properties
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ WorkflowOutputString

Deserialize a JSON object to an instance of WorkflowOutputString

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  id = struct.id
  name = struct.name
  value = struct.value
  new(id: id, name: name, value: value, 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) 


50
51
52
53
54
 
# File 'lib/vellum_ai/types/workflow_output_string.rb', line 50

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of WorkflowOutputString to a JSON object

Returns:

  • (JSON) 


42
43
44
 
# File 'lib/vellum_ai/types/workflow_output_string.rb', line 42

def to_json(*_args)
  { "id": @id, "name": @name, "value": @value }.to_json
end