Class: Vellum::BaseOutput

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value: OMIT, delta: OMIT, name:, additional_properties: nil) ⇒ Vellum::BaseOutput

Parameters:

  • value (Hash{String => Object}) (defaults to: OMIT)
  • delta (Hash{String => Object}) (defaults to: OMIT)
  • name (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(value: OMIT, delta: OMIT, name:, additional_properties: nil)
  @value = value if value != OMIT
  @delta = delta if delta != OMIT
  @name = name
  @additional_properties = additional_properties
  @_field_set = { "value": value, "delta": delta, "name": name }.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/base_output.rb', line 14

def additional_properties
  @additional_properties
end

#delta ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


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

def delta
  @delta
end

#name ⇒ String (readonly)

Returns:

  • (String) 


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

def name
  @name
end

#value ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


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

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::BaseOutput

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  value = parsed_json["value"]
  delta = parsed_json["delta"]
  name = parsed_json["name"]
  new(
    value: value,
    delta: delta,
    name: name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


55
56
57
 
# File 'lib/vellum_ai/types/base_output.rb', line 55

def to_json
  @_field_set&.to_json
end