Class: Vellum::MlModelRead

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

Overview

An ML Model that your Workspace has access to.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, introduced_on:, additional_properties: nil) ⇒ Vellum::MlModelRead

Parameters:

  • id (String)
  • name (String) —

    The unique name of the ML Model.

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

    Additional properties unmapped to the current class definition



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

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



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

def additional_properties
  @additional_properties
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#introduced_on ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


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

def introduced_on
  @introduced_on
end

#name ⇒ String (readonly)

Returns The unique name of the ML Model.

Returns:

  • (String) —

    The unique name of the ML Model.



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

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::MlModelRead

Parameters:

  • json_object (String)

Returns:



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

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"]
  introduced_on = unless parsed_json["introduced_on"].nil?
  DateTime.parse(parsed_json["introduced_on"])
else
  nil
end
  new(
    id: id,
    name: name,
    introduced_on: introduced_on,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


68
69
70
71
72
 
# File 'lib/vellum_ai/types/ml_model_read.rb', line 68

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


59
60
61
 
# File 'lib/vellum_ai/types/ml_model_read.rb', line 59

def to_json
  @_field_set&.to_json
end