Class: Vellum::ExternalInputDescriptor

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(types:, inputs_class: OMIT, instance: OMIT, name:, additional_properties: nil) ⇒ Vellum::ExternalInputDescriptor

Parameters:



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

def initialize(types:, inputs_class: OMIT, instance: OMIT, name:, additional_properties: nil)
  @types = types
  @inputs_class = inputs_class if inputs_class != OMIT
  @instance = instance if instance != OMIT
  @name = name
  @additional_properties = additional_properties
  @_field_set = { "types": types, "inputs_class": inputs_class, "instance": instance, "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



17
18
19
 
# File 'lib/vellum_ai/types/external_input_descriptor.rb', line 17

def additional_properties
  @additional_properties
end

#inputs_class ⇒ Vellum::CodeResourceDefinition (readonly)

Returns:



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

def inputs_class
  @inputs_class
end

#instance ⇒ Object (readonly)

Returns:

  • (Object) 


13
14
15
 
# File 'lib/vellum_ai/types/external_input_descriptor.rb', line 13

def instance
  @instance
end

#name ⇒ String (readonly)

Returns:

  • (String) 


15
16
17
 
# File 'lib/vellum_ai/types/external_input_descriptor.rb', line 15

def name
  @name
end

#types ⇒ Array<Vellum::CodeResourceDefinition> (readonly)

Returns:



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

def types
  @types
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::ExternalInputDescriptor

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  types = parsed_json["types"]&.map do | item |
  item = item.to_json
  Vellum::CodeResourceDefinition.from_json(json_object: item)
end
  unless parsed_json["inputs_class"].nil?
    inputs_class = parsed_json["inputs_class"].to_json
    inputs_class = Vellum::CodeResourceDefinition.from_json(json_object: inputs_class)
  else
    inputs_class = nil
  end
  instance = parsed_json["instance"]
  name = parsed_json["name"]
  new(
    types: types,
    inputs_class: inputs_class,
    instance: instance,
    name: name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


79
80
81
82
83
84
 
# File 'lib/vellum_ai/types/external_input_descriptor.rb', line 79

def self.validate_raw(obj:)
  obj.types.is_a?(Array) != false || raise("Passed value for field obj.types is not the expected type, validation failed.")
  obj.inputs_class.nil? || Vellum::CodeResourceDefinition.validate_raw(obj: obj.inputs_class)
  obj.instance&.is_a?(Object) != false || raise("Passed value for field obj.instance 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) 


70
71
72
 
# File 'lib/vellum_ai/types/external_input_descriptor.rb', line 70

def to_json
  @_field_set&.to_json
end