Class: Vellum::CodeResourceDefinition

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

Overview

The definition of a resource defined in code.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, module_:, additional_properties: nil) ⇒ Vellum::CodeResourceDefinition

Parameters:

  • name (String) —

    The name of the resource, typically a class name.

  • module_ (Array<String>) —

    The module that this resource is defined in.

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

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
 
# File 'lib/vellum_ai/types/code_resource_definition.rb', line 24

def initialize(name:, module_:, additional_properties: nil)
  @name = name
  @module_ = module_
  @additional_properties = additional_properties
  @_field_set = { "name": name, "module": module_ }
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



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

def additional_properties
  @additional_properties
end

#module_ ⇒ Array<String> (readonly)

Returns The module that this resource is defined in.

Returns:

  • (Array<String>) —

    The module that this resource is defined in.



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

def module_
  @module_
end

#name ⇒ String (readonly)

Returns The name of the resource, typically a class name.

Returns:

  • (String) —

    The name of the resource, typically a class name.



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

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::CodeResourceDefinition

Parameters:

  • json_object (String)

Returns:



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/vellum_ai/types/code_resource_definition.rb', line 34

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


57
58
59
60
 
# File 'lib/vellum_ai/types/code_resource_definition.rb', line 57

def self.validate_raw(obj:)
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.module_.is_a?(Array) != false || raise("Passed value for field obj.module_ is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


48
49
50
 
# File 'lib/vellum_ai/types/code_resource_definition.rb', line 48

def to_json
  @_field_set&.to_json
end