Class: Vellum::WorkflowOutputImage

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

Overview

An image output from a Workflow execution.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

  • id (String)
  • name (String) —

    The output’s name, as defined in the workflow

  • type (String)
  • value (Vellum::VellumImage) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vellum_ai/types/workflow_output_image.rb', line 31

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



18
19
20
 
# File 'lib/vellum_ai/types/workflow_output_image.rb', line 18

def additional_properties
  @additional_properties
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String (readonly)

Returns The output’s name, as defined in the workflow.

Returns:

  • (String) —

    The output’s name, as defined in the workflow



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

def name
  @name
end

#type ⇒ String (readonly)

Returns:

  • (String) 


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

def type
  @type
end

#value ⇒ Vellum::VellumImage (readonly)

Returns:



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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::WorkflowOutputImage

Parameters:

  • json_object (String)

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/vellum_ai/types/workflow_output_image.rb', line 45

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"]
  unless parsed_json["value"].nil?
    value = parsed_json["value"].to_json
    value = Vellum::VellumImage.from_json(json_object: value)
  else
    value = nil
  end
  new(
    id: id,
    name: name,
    type: type,
    value: value,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


77
78
79
80
81
82
 
# File 'lib/vellum_ai/types/workflow_output_image.rb', line 77

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.nil? || Vellum::VellumImage.validate_raw(obj: obj.value)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


68
69
70
 
# File 'lib/vellum_ai/types/workflow_output_image.rb', line 68

def to_json
  @_field_set&.to_json
end